chrono::parsers::ChParserFsiYAML Class Reference

Description

Utility class to parse a YAML specification file for a coupled FSI problem.

#include <ChParserFsiYAML.h>

Public Member Functions

 ChParserFsiYAML (const std::string &yaml_filename, bool verbose=false)
 Create a YAML parser and load the model from the specified input YAML file.
 
void SetVerbose (bool verbose)
 Set verbose temrinal output (default: false).
 
void LoadFile (const std::string &yaml_filename)
 Load the specified input YAML file.
 
void CreateFsiSystem ()
 Create and return a ChFsiSystem combining a Chrono MBS system and a fluid solver.
 
const std::string & GetName () const
 Return the name of the FSI model.
 
ChParserMbsYAMLGetMbsParser () const
 Return the multibody YAML parser.
 
ChParserCfdYAMLGetCfdParser () const
 Return the fluid YAML parser.
 
std::shared_ptr< fsi::ChFsiSystemGetFsiSystem () const
 Return the FSI system.
 
ChParserCfdYAML::FluidSystemType GetFluidSystemType () const
 Return fluid system type.
 
std::shared_ptr< fsi::ChFsiFluidSystemGetFluidSystem () const
 Return the fluid system.
 
std::shared_ptr< ChSystemGetMultibodySystem () const
 Return the MBS system.
 
double GetTimestep () const
 Get meta-step (communication time step).
 
double GetEndtime () const
 Get simulation end time. More...
 
bool Render () const
 Indicate whether to enable run-time visualization.
 
double GetRenderFPS () const
 Return frequency (frames-per-second) for run-time visualization rendering.
 
bool Output () const
 Indicate whether to enable simulation output.
 
double GetOutputFPS () const
 Return frequency (frames-per-second) for simulation output.
 

Member Function Documentation

◆ GetEndtime()

double chrono::parsers::ChParserFsiYAML::GetEndtime ( ) const
inline

Get simulation end time.

A value of -1 indicates infinite end time.


The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono_parsers/yaml/ChParserFsiYAML.h
  • /builds/uwsbel/chrono/src/chrono_parsers/yaml/ChParserFsiYAML.cpp