chrono::fsi::tdpf::ChFsiSystemTDPF Class Reference

Description

FSI system using a TDPF-based fluid solver.

#include <ChFsiSystemTDPF.h>

Inheritance diagram for chrono::fsi::tdpf::ChFsiSystemTDPF:
Collaboration diagram for chrono::fsi::tdpf::ChFsiSystemTDPF:

Public Member Functions

 ChFsiSystemTDPF (ChSystem *sysMBS, ChFsiFluidSystemTDPF *sysTDPF, bool use_generic_interface=false)
 Construct an FSI system to couple the specified Chrono MBS system and TDPF fluid system.
 
ChFsiFluidSystemTDPFGetFluidSystemTDPF () const
 Access the associated TDPF fluid system.
 
void SetHydroFilename (const std::string &filename)
 Set input file name with hydro data (HDF5 format).
 
virtual void Initialize () override
 Initialize the FSI system. More...
 
- Public Member Functions inherited from chrono::fsi::ChFsiSystem
virtual ~ChFsiSystem ()
 Destructor for the FSI system.
 
void AttachFluidSystem (ChFsiFluidSystem *sys)
 Attach a fluid system.
 
void AttachMultibodySystem (ChSystem *sys)
 Attach a MBS system.
 
ChFsiFluidSystemGetFluidSystem () const
 Access the associated fluid system.
 
ChSystemGetMultibodySystem () const
 Access the associated multibody system.
 
ChFsiInterfaceGetFsiInterface () const
 Access the associated FSI interface.
 
void SetVerbose (bool verbose)
 Enable/disable verbose terminal output (default: true). More...
 
void SetGravitationalAcceleration (const ChVector3d &gravity)
 Set gravitational acceleration for the FSI syatem. More...
 
void SetStepSizeCFD (double step)
 Set integration step size for fluid dynamics.
 
void SetStepsizeMBD (double step)
 Set integration step size for multibody dynamics. More...
 
std::shared_ptr< FsiBodyAddFsiBody (std::shared_ptr< ChBody > body, std::shared_ptr< ChBodyGeometry > geometry, bool check_embedded)
 Add a rigid body to the FSI system.
 
std::shared_ptr< FsiMesh1DAddFsiMesh1D (std::shared_ptr< fea::ChMesh > mesh, bool check_embedded)
 Add an FEA mesh to the FSI system. More...
 
std::shared_ptr< FsiMesh2DAddFsiMesh2D (std::shared_ptr< fea::ChMesh > mesh, bool check_embedded)
 Add an FEA mesh to the FSI system. More...
 
void UseNodeDirections (NodeDirectionsMode mode)
 Enable use and set method of obtaining FEA node directions. More...
 
void RegisterMBDCallback (std::shared_ptr< MBDCallback > callback)
 Set a custom function for advancing the dynamics of the associated multibody system. More...
 
void DoStepDynamics (double step)
 Function to advance the FSI system combined state. More...
 
double GetSimTime () const
 Get current simulation time.
 
double GetStepSizeMBD () const
 Get the integration step size for multibody dynamics.
 
double GetStepSizeCFD () const
 Get the integration step size for fluid dynamics.
 
double GetRtf () const
 Get current estimated RTF (real time factor) for the coupled problem.
 
void SetRtf (double rtf)
 Set RTF value for the coupled problem. More...
 
double GetRtfCFD () const
 Get current estimated RTF (real time factor) for the fluid system.
 
double GetRtfMBD () const
 Get current estimated RTF (real time factor) for the multibody system.
 
double GetRatioMBD () const
 Get ratio of simulation time spent in MBS integration.
 
double GetTimerStep () const
 Return the time in seconds for for simulating the last step.
 
double GetTimerCFD () const
 Return the time in seconds for fluid dynamics over the last step.
 
double GetTimerMBD () const
 Return the time in seconds for multibody dynamics over the last step.
 
double GetTimerFSI () const
 Return the time in seconds for data exchange between phases over the last step.
 
const std::vector< std::shared_ptr< FsiBody > > & GetBodies () const
 Get a list of the FSI rigid bodies.
 
const ChVector3dGetFsiBodyForce (size_t i) const
 Return the FSI applied force on the body with specified index (as returned by AddFsiBody). More...
 
const ChVector3dGetFsiBodyTorque (size_t i) const
 Return the FSI applied torque on the body with specified index (as returned by AddFsiBody). More...
 

Additional Inherited Members

- Protected Member Functions inherited from chrono::fsi::ChFsiSystem
 ChFsiSystem (ChSystem *sysMBS, ChFsiFluidSystem *sysCFD)
 Construct an FSI system coupling the provided multibody and fluid systems. More...
 
- Protected Attributes inherited from chrono::fsi::ChFsiSystem
ChSystemm_sysMBS
 multibody system
 
ChFsiFluidSystemm_sysCFD
 FSI fluid solver.
 
std::shared_ptr< ChFsiInterfacem_fsi_interface
 FSI interface system.
 
bool m_verbose
 enable/disable m_verbose terminal output
 
bool m_is_initialized
 set to true once the Initialize function is called
 

Member Function Documentation

◆ Initialize()

void chrono::fsi::tdpf::ChFsiSystemTDPF::Initialize ( )
overridevirtual

Initialize the FSI system.

A call to this function marks the completion of system construction.

Reimplemented from chrono::fsi::ChFsiSystem.


The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono_fsi/tdpf/ChFsiSystemTDPF.h
  • /builds/uwsbel/chrono/src/chrono_fsi/tdpf/ChFsiSystemTDPF.cpp