BodyForceParameters Class Reference

Body force over a mesh using the "Add_BF" command. More...

#include <Parameters.h>

Inheritance diagram for BodyForceParameters:

Public Member Functions
void	print_parameters ()
void	set_values (tinyxml2::XMLElement *xml_elem)
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< bool >	ramp_function
Parameter< double >	value
Parameter< std::string >	fourier_coefficients_file_path
Parameter< std::string >	spatial_values_file_path
Parameter< std::string >	temporal_and_spatial_values_file_path
Parameter< std::string >	temporal_values_file_path
Parameter< std::string >	time_dependence
Parameter< std::string >	type
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_ = "Add_BF"
	Define the XML element name for boundary condition parameters. More...

Detailed Description

Body force over a mesh using the "Add_BF" command.

<Add_BF mesh="msh" >
  <Type> volumetric </Type>
  <Time_dependence> general </Time_dependence>
  <Temporal_and_spatial_values_file_path> bforce.dat </Temporal_and_spatial_values_file_path>
</Add_BF>

Member Data Documentation

xml_element_name_

const std::string BodyForceParameters::xml_element_name_ = "Add_BF"

static

Define the XML element name for boundary condition parameters.

---

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

• solver/Parameters.h
• solver/Parameters.cpp