Public Types |
Public Member Functions |
Static Public Member Functions |
Protected Attributes |
List of all members
chrono::parsers::ChParserCfdYAML Class Referenceabstract
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, TDPF } |
 Public Types inherited from chrono::parsers::ChParserYAML | |
| enum | YamlFileType { MBS, SPH, TDPF, FSI, VEHICLE, UNKNOWN } |
| Type of a Chrono YAML specification file. | |
Public Member Functions | |
| ChParserCfdYAML (bool verbose=false) | |
| FluidSystemType | GetType () const |
| Return the fluid system type. | |
| virtual std::shared_ptr< fsi::ChFsiSystem > | GetFsiSystem ()=0 |
| Access the underlying FSI system. | |
| virtual std::shared_ptr< fsi::ChFsiFluidSystem > | GetFluidSystem ()=0 |
| Access the underlying fluid system. | |
| Public Member Functions inherited from chrono::parsers::ChParserYAML | |
| void | SetVerbose (bool verbose) |
| Set verbose terminal output (default: false). | |
| virtual void | SetOutputDir (const std::string &out_dir) |
| Set root output directory (default: "."). More... | |
| const std::string & | GetName () const |
| Return the name of the YAML model. | |
| virtual bool | OutputEnabled () const |
| Return true if generating output. | |
| 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. | |
| virtual bool | VisualizationEnabled () const |
| Return true if visualization is enabled. | |
| 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 | LoadSimData (const YAML::Node &yaml) |
| Load simulation settings for this parser from the specified YAML node. More... | |
| virtual void | WriteOutput (int frame, double time) |
| Write simulation output results at the current time. More... | |
| virtual void | Output (double time) |
| Generate output at the current frame. 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... | |
Static Public Member Functions | |
| static FluidSystemType | ReadFluidSystemType (const std::string &yaml_filename) |
| Peek in specified YAML file and read the fluid system type. More... | |
| 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... | |
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) | |
| 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 | |
Additional Inherited Members | |
| Static Protected Member Functions inherited from chrono::parsers::ChParserYAML | |
| static YamlFileType | ReadYamlFileType (const YAML::Node &a) |
| Read the YAML file type. | |
Member Function Documentation
◆ ReadFluidSystemType()
|
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
