Description

Parser for YAML specification file for a coupled FSI problem.

#include <ChParserFsiYAML.h>

Inheritance diagram for chrono::parsers::ChParserFsiYAML:

Collaboration diagram for chrono::parsers::ChParserFsiYAML:

[legend]

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	LoadFile (const std::string &yaml_filename)
	Load the specified input YAML file.

void	LoadFsiData (const YAML::Node &yaml)

void	LoadSimData (const YAML::Node &yaml) override
	Load the simulation and visualization settings from the specified YAML node.

void	CreateFsiSystem ()
	Create and return a ChFsiSystem combining a Chrono MBS system and a fluid solver.

ChParserMbsYAML &	GetMbsParser () const
	Return the multibody YAML parser.

ChParserCfdYAML &	GetCfdParser () const
	Return the fluid YAML parser.

std::shared_ptr< fsi::ChFsiSystem >	GetFsiSystem () const
	Return the FSI system.

ChParserCfdYAML::FluidSystemType	GetFluidSystemType () const
	Return fluid system type.

std::shared_ptr< fsi::ChFsiFluidSystem >	GetFluidSystem () const
	Return the fluid system.

std::shared_ptr< ChSystem >	GetMultibodySystem () const
	Return the MBS system.

double	GetTimestep () const
	Get meta-step (communication time step).

double	GetEndtime () const
	Get simulation end time. More...

virtual void	SetOutputDir (const std::string &out_dir) override
	Set root output directory (default: "."). More...

virtual bool	OutputEnabled () const override
	Return true if generating output. More...

virtual bool	VisualizationEnabled () const override
	Return true if visualization is enabled. More...

virtual void	Output (double time) override
	Generate output at the current frame. More...

Public Member Functions inherited from chrono::parsers::ChParserYAML
void	SetVerbose (bool verbose)
	Set verbose terminal output (default: false).

const std::string &	GetName () const
	Return the name of the YAML model.

const ChOutput::Settings &	GetOutputSettings () const
	Return all output settings.

ChOutput::Format	GetOutputFormat () const
	Return the output type.

ChOutput::Mode	GetOutputMode () const
	Return the output mode.

virtual double	GetOutputFPS () const
	Return the output frequency.

const ChVisualSystem::Settings &	GetVisualizationSettings () const
	Return all visualization settings.

double	GetRenderFPS () const

CameraVerticalDir	GetCameraVerticalDir () const

const ChVector3d &	GetCameraLocation () const

const ChVector3d &	GetCameraTarget () const

bool	EnableShadows () const

bool	WriteImages () const

const std::string &	GetImageDir () const

virtual void	WriteOutput (int frame, double time)
	Write simulation output results at the current time. More...

virtual bool	Render (ChVisualSystem &vis, double time)
	Render the current frame using the specified visual system if run-time visualization is available and enabled. More...

Additional Inherited Members
Public Types inherited from chrono::parsers::ChParserYAML
enum	YamlFileType { MBS, SPH, TDPF, FSI, VEHICLE, UNKNOWN }
	Type of a Chrono YAML specification file.

Static Public Member Functions inherited from chrono::parsers::ChParserYAML
static YamlFileType	ReadYamlFileType (const std::string &yaml_filename)
	Peek in specified YAML file and read the fluid system type. More...

Static Protected Member Functions inherited from chrono::parsers::ChParserYAML
static YamlFileType	ReadYamlFileType (const YAML::Node &a)
	Read the YAML file type.

Protected Attributes inherited from chrono::parsers::ChParserYAML
std::string	m_name
	name of the YAML model

bool	m_verbose
	verbose terminal output (default: false)

bool	m_use_degrees
	all angles given in degrees (default: true)

ChVisualSystem::Settings	m_vis_settings
	visualization settings

ChOutput::Settings	m_output_settings
	output settings

std::string	m_output_dir
	root output directory

std::shared_ptr< ChOutput >	m_output_db
	output database

ChYamlFileHandler	m_file_handler
	handler for data file paths

Member Function Documentation

◆ GetEndtime()

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

inline

Get simulation end time.

A value of -1 indicates infinite end time.

◆ Output()

void chrono::parsers::ChParserFsiYAML::Output ( double time )

overridevirtual

Generate output at the current frame.

This override generates output for any of the two phases (MBS or CFD) for which output was enabled. This function ensures that output occurs at the specified frequency.

Reimplemented from chrono::parsers::ChParserYAML.