svFSIplus
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
VariableWallPropsParameters Class Reference

The VariableWallPropsParameters class stores parameters for variable wall properties for the CMM equation. More...

#include <Parameters.h>

Inheritance diagram for VariableWallPropsParameters:
[legend]

Public Member Functions

bool defined () const
 
void set_values (tinyxml2::XMLElement *xml_elemnt)
 
- Public Member Functions inherited from ParameterLists
void set_xml_element_name (const std::string &name)
 
void set_parameter (const std::string &name, const bool value, bool required, Parameter< bool > &param)
 Set the name, default value and the parameter required flag. More...
 
void set_parameter (const std::string &name, const double value, bool required, Parameter< double > &param)
 
void set_parameter (const std::string &name, std::initializer_list< double > value, bool required, VectorParameter< double > &param)
 
void set_parameter (const std::string &name, std::initializer_list< int > value, bool required, VectorParameter< int > &param)
 
void set_parameter (const std::string &name, std::initializer_list< std::string > value, bool required, VectorParameter< std::string > &param)
 
void set_parameter (const std::string &name, const int value, bool required, Parameter< int > &param, std::vector< int > range={})
 
void set_parameter (const std::string &name, const std::string &value, bool required, Parameter< std::string > &param)
 
void set_parameter_value (const std::string &name, const std::string &value)
 Set the value of a paramter from a string. More...
 
void check_required ()
 Check if any required parameters have not been set. More...
 
std::map< std::string, std::string > get_parameter_list ()
 Get the defined parameters as a map of strings. More...
 
void print_parameter_list ()
 Print the parameters. More...
 

Public Attributes

Parameter< std::string > mesh_name
 
Parameter< std::string > wall_properties_file_path
 
bool value_set = false
 
- Public Attributes inherited from ParameterLists
std::map< std::string, std::variant< Parameter< bool > *, Parameter< double > *, Parameter< int > *, Parameter< std::string > *, VectorParameter< double > *, VectorParameter< int > *, VectorParameter< std::string > * > > params_map
 Map used for storing parameters by name / Parameter template union. More...
 
std::string xml_element_name = ""
 

Static Public Attributes

static const std::string xml_element_name_ = "Variable_wall_properties"
 The VariableWallPropsParameters class stores parameters for variable wall properties for the CMM equation. More...
 

Detailed Description

The VariableWallPropsParameters class stores parameters for variable wall properties for the CMM equation.

Member Data Documentation

◆ xml_element_name_

const std::string VariableWallPropsParameters::xml_element_name_ = "Variable_wall_properties"
static

The VariableWallPropsParameters class stores parameters for variable wall properties for the CMM equation.

Define the XML element name for variable wall parameters.


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