chrono::parsers::ChParserCfdYAML Class Reference

Description

Base class for YAML parsers for fluid systems.

#include <ChParserCfdYAML.h>

Inheritance diagram for chrono::parsers::ChParserCfdYAML:

Collaboration diagram for chrono::parsers::ChParserCfdYAML:

Public Types
enum	FluidSystemType { SPH, BEM }
Public Types inherited from chrono::parsers::ChParserYAML
enum	DataPathType { ABS, REL }

Public Member Functions
	ChParserCfdYAML (bool verbose=false)
FluidSystemType	GetType () const
	Return the fluid system type.
Public Member Functions inherited from chrono::parsers::ChParserYAML
void	SetVerbose (bool verbose)
	Set verbose terminal output (default: false).
void	SetOutputDir (const std::string &out_dir)
	Set root output directory (default: "").
const std::string &	GetName () const
	Return the name of the YAML model.
virtual bool	Output () const
	Return true if generating output.
ChOutput::Type	GetOutputType () const
	Return the output type.
virtual double	GetOutputFPS () const
	Return the output frequency.
virtual void	SaveOutput (int frame)
	Save simulation output results at the current time.

Static Public Member Functions
static FluidSystemType	ReadFluidSystemType (const std::string &yaml_filename)
	Peek in specified YAML file and read the fluid system type. More...

Protected Attributes
FluidSystemType	m_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)
std::string	m_output_dir
	root oputput directory
std::shared_ptr< ChOutput >	m_output_db
	output database
DataPathType	m_data_path
std::string	m_rel_path
std::string	m_script_directory
OutputParameters	m_output

Additional Inherited Members
Protected Member Functions inherited from chrono::parsers::ChParserYAML
std::string	GetDatafilePath (const std::string &filename)
	Return the path to the specified data file.
Static Protected Member Functions inherited from chrono::parsers::ChParserYAML
static void	CheckVersion (const YAML::Node &a)
static std::string	ToUpper (std::string in)
static DataPathType	ReadDataPathType (const YAML::Node &a)
	Read the data path type (absolute or relative).
static ChVector3d	ReadVector (const YAML::Node &a)
	Load and return a ChVector3d from the specified node.
static ChQuaterniond	ReadQuaternion (const YAML::Node &a)
	Load and return a ChQuaternion from the specified node.
static ChQuaterniond	ReadCardanAngles (const YAML::Node &a, bool use_degrees)
	Load a Cardan angle sequence from the specified node and return as a quaternion. More...
static ChQuaterniond	ReadRotation (const YAML::Node &a, bool use_degrees)
	Return a quaternion loaded from the specified node. More...
static ChCoordsysd	ReadCoordinateSystem (const YAML::Node &a, bool use_degrees)
	Load and return a coordinate system from the specified node.
static std::shared_ptr< ChFunction >	ReadFunction (const YAML::Node &a, bool use_degrees)
	Load and return a ChFunction object from the specified node.
static ChColor	ReadColor (const YAML::Node &a)
	Load and return a ChColor from the specified node.
static ChOutput::Type	ReadOutputType (const YAML::Node &a)
static ChOutput::Mode	ReadOutputMode (const YAML::Node &a)
static void	PrintNodeType (const YAML::Node &node)
	Print YAML node type.

Member Function Documentation

ReadFluidSystemType()

ChParserCfdYAML::FluidSystemType chrono::parsers::ChParserCfdYAML::ReadFluidSystemType ( const std::string &  yaml_filename )

static

Peek in specified YAML file and read the fluid system type.

Throws a runtime error if the type is unknown.

---

The documentation for this class was generated from the following files:

• /builds/uwsbel/chrono/src/chrono_parsers/yaml/ChParserCfdYAML.h
• /builds/uwsbel/chrono/src/chrono_parsers/yaml/ChParserCfdYAML.cpp