ActiveStressODE::Parameters Class Reference

Model parameters class. More...

#include <ActiveStressODE.h>

Inheritance diagram for ActiveStressODE::Parameters:

Public Member Functions
	Parameters (const std::string &label)
Public Member Functions inherited from ActiveStressModelParameters
	ActiveStressModelParameters (const std::string &xml_element_name_)
	Constructor.
bool	defined () const
	Return whether the parameters represented by this object were defined.
void	print_parameters () const
	Print the value of parameters.
void	set_values (const tinyxml2::XMLElement *xml_elem)
	Set the values of parameters in this object from an XML element.
double	get_scalar (const std::string &label) const
	Get the value of a parameter by label.
void	set_scalar (const std::string &label, double value)
	Set the value of a scalar parameter by label.
std::string	get_string (const std::string &label) const
	Get the value of a string parameter by label.
bool	get_bool (const std::string &label) const
	Get the value of a bool parameter by label.
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.
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_CANN (const std::string &name, const std::string &value)
	set_parameter function to handle CANNRow
void	set_parameter_value (const std::string &name, const std::string &value)
	Set the value of a paramter from a string.
void	check_required ()
	Check if any required parameters have not been set.
std::map< std::string, std::string >	get_parameter_list () const
	Get the defined parameters as a map of strings.
void	print_parameter_list ()
	Print the parameters.

Additional Inherited Members
Public Attributes inherited from ActiveStressModelParameters
const std::string	xml_element_name
	Name of the XML element for this object.
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.
std::string	xml_element_name = ""
Protected Member Functions inherited from ActiveStressModelParameters
void	add_parameter (const std::string &label, double default_value, bool required)
	Add a new parameter to this object.
void	add_parameter (const std::string &label, const std::string &default_value, bool required)
	Add a new parameter to this object.
void	add_parameter (const std::string &label, bool default_value, bool required)
	Add a new parameter to this object.
Protected Attributes inherited from ActiveStressModelParameters
std::map< std::string, Parameter< double > >	double_parameters
	Double-valued parameters.
std::map< std::string, Parameter< std::string > >	string_parameters
	String-valued parameters.
std::map< std::string, Parameter< bool > >	bool_parameters
	Bool-valued parameters.
bool	value_set = false

Detailed Description

Model parameters class.

Declares parameters that are common to all ODE-based active stress models. Classes derived from ActiveStressODE one should declare their own Parameters class, deriving from ActiveStressODE::parameters.

---

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

• solver/ActiveStressODE.h