ActiveStressParameters Class Reference

Parameters for active stress models. More...

#include <Parameters.h>

Inheritance diagram for ActiveStressParameters:

Public Member Functions
	ActiveStressParameters ()
	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.
std::string	get_model_name () const
double	get_eta_f () const
	Get the active tension coefficient along fibers.
double	get_eta_s () const
	Get the active tension coefficient along sheets.
double	get_eta_n () const
	Get the active tension coefficient along sheet normals.
const ActiveStressModelParameters &	get_parameters (const std::string &model_name) const
	Get the parameters for a given active stress model.
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.

Static Public Attributes
static const std::string	xml_element_name = "Active_stress"
	Name of the XML element for this object.

Protected Attributes
Parameter< std::string >	model_name
	Parameter for the model name.
DirectionalDistributionParameters	directional_distribution
	Parameters for the directional distribution of active tension.
std::map< std::string, std::unique_ptr< ActiveStressModelParameters > >	active_stress_models
bool	value_set = false

Additional Inherited Members
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 = ""

Detailed Description

Parameters for active stress models.

This class stores all the parameters related to active stress, including e.g. the name of the specific selected model. The parameters specific to an individual model are managed by the class ActiveStressModelParameters, of which this class owns an instance for every registered model.

In the XML file, this class corresponds to the <Active_stress> element.

Constructor & Destructor Documentation

ActiveStressParameters()

ActiveStressParameters::ActiveStressParameters

(

)

Constructor.

Member Function Documentation

defined()

bool ActiveStressParameters::defined ( ) const

inline

Return whether the parameters represented by this object were defined.

get_eta_f()

double ActiveStressParameters::get_eta_f

(

)

const

Get the active tension coefficient along fibers.

get_eta_n()

double ActiveStressParameters::get_eta_n

(

)

const

Get the active tension coefficient along sheet normals.

get_eta_s()

double ActiveStressParameters::get_eta_s

(

)

const

Get the active tension coefficient along sheets.

get_model_name()

std::string ActiveStressParameters::get_model_name

(

)

const

Get the name of the selected model. Throws an exception if it has not been set.

get_parameters()

const ActiveStressModelParameters & ActiveStressParameters::get_parameters

(

const std::string &

model_name

)

const

Get the parameters for a given active stress model.

print_parameters()

void ActiveStressParameters::print_parameters

(

)

const

Print the value of parameters.

set_values()

void ActiveStressParameters::set_values

(

const tinyxml2::XMLElement *

xml_elem

)

Set the values of parameters in this object from an XML element.

Member Data Documentation

active_stress_models

std::map<std::string, std::unique_ptr<ActiveStressModelParameters> > ActiveStressParameters::active_stress_models

protected

Active stress model parameters. Keys are the model names, as registered in the ActiveStressModelFactory.

directional_distribution

DirectionalDistributionParameters ActiveStressParameters::directional_distribution

protected

Parameters for the directional distribution of active tension.

model_name

Parameter<std::string> ActiveStressParameters::model_name

protected

Parameter for the model name.

value_set

bool ActiveStressParameters::value_set = false

protected

Flag indicating whether the values of the parameters stored in this object have been set.

xml_element_name

const std::string ActiveStressParameters::xml_element_name = "Active_stress"

static

Name of the XML element for this object.

---

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

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