Generic ionic model initial conditions parameters. More...

#include <Parameters.h>

Inheritance diagram for IonicInitialStateParameters:

Public Member Functions
	IonicInitialStateParameters (const std::string &xml_element_name_, const std::vector< std::pair< std::string, double > > &states)
	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 value of parameters in this object from an XML element.

double	operator[] (const std::string &label) const
	Get the value of a 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.

Public Attributes
const std::string	xml_element_name
	Name of the XML element for this object.

const bool	required

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 Attributes
std::map< std::string, Parameter< double > >	parameters
	Parameter instances underlying this object.

bool	value_set = false

Detailed Description

Generic ionic model initial conditions parameters.

Constructor & Destructor Documentation

◆ IonicInitialStateParameters()

IonicInitialStateParameters::IonicInitialStateParameters	(	const std::string &	xml_element_name_,
		const std::vector< std::pair< std::string, double > > &	states
	)

Constructor.

Member Function Documentation

◆ defined()

bool IonicInitialStateParameters::defined ( ) const

inline

Return whether the parameters represented by this object were defined.

◆ operator[]()

double IonicInitialStateParameters::operator[] ( const std::string & label ) const

inline

Get the value of a parameter by label.

◆ print_parameters()

void IonicInitialStateParameters::print_parameters ( ) const

Print the value of parameters.

◆ set_values()

void IonicInitialStateParameters::set_values ( const tinyxml2::XMLElement * xml_elem )

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

Member Data Documentation

◆ parameters

std::map<std::string, Parameter<double> > IonicInitialStateParameters::parameters

protected

Parameter instances underlying this object.

◆ required

const bool IonicInitialStateParameters::required

Flag indicating whether these XML section represented by this object is required. It is set to true if the number of states provided to the constructor is greater than zero.

◆ value_set

bool IonicInitialStateParameters::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 IonicInitialStateParameters::xml_element_name

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

Public Member Functions

Public Attributes

Protected Attributes