Initial conditions parameters for a generic ionic model. More...

#include <Parameters.h>

Inheritance diagram for IonicModelParameters:

Public Member Functions
	IonicModelParameters (const std::string &xml_element_name_, const std::vector< std::pair< std::string, double > > &initial_X, const std::vector< std::pair< std::string, double > > &initial_Xg)
	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.

const IonicInitialStateParameters &	get_initial_X () const
	Get the parameters for the state variables.

const IonicInitialStateParameters &	get_initial_Xg () const
	Get the parameters for the gating variables.

double	get_scalar (const std::string &label) const
	Get the value of a scalar parameter by label.

Vector< double >	get_vector (const std::string &label) const
	Get the value of a vector 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.

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
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, std::initializer_list< double > default_value, bool required)
	Add a new vector parameter to this object.

Protected Attributes
IonicInitialStateParameters	initial_X_parameters
	Parameters for the state variables.

IonicInitialStateParameters	initial_Xg_parameters
	Parameters for the gating variables.

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

std::map< std::string, VectorParameter< double > >	vector_parameters
	Vector parameters are stored in a map as key-parameter pairs.

bool	value_set = false

Detailed Description

Initial conditions parameters for a generic ionic model.

Bundles initial conditions for the model's ionic concentrations and gating variables, represented by two instances of IonicInitialStateParameters.

Constructor & Destructor Documentation

◆ IonicModelParameters()

IonicModelParameters::IonicModelParameters	(	const std::string &	xml_element_name_,
		const std::vector< std::pair< std::string, double > > &	initial_X,
		const std::vector< std::pair< std::string, double > > &	initial_Xg
	)

Constructor.

Member Function Documentation

◆ add_parameter() [1/2]

void IonicModelParameters::add_parameter	(	const std::string &	label,
		double	default_value,
		bool	required
	)

inlineprotected

Add a new parameter to this object.

◆ add_parameter() [2/2]

void IonicModelParameters::add_parameter	(	const std::string &	label,
		std::initializer_list< double >	default_value,
		bool	required
	)

inlineprotected

Add a new vector parameter to this object.

◆ defined()

bool IonicModelParameters::defined ( ) const

inline

Return whether the parameters represented by this object were defined.

◆ get_initial_X()

const IonicInitialStateParameters & IonicModelParameters::get_initial_X ( ) const

inline

Get the parameters for the state variables.

◆ get_initial_Xg()

const IonicInitialStateParameters & IonicModelParameters::get_initial_Xg ( ) const

inline

Get the parameters for the gating variables.

◆ get_scalar()

double IonicModelParameters::get_scalar ( const std::string & label ) const

inline

Get the value of a scalar parameter by label.

◆ get_vector()

Vector< double > IonicModelParameters::get_vector ( const std::string & label ) const

inline

Get the value of a vector parameter by label.

◆ print_parameters()

void IonicModelParameters::print_parameters ( ) const

Print the value of parameters.

◆ set_values()

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

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

Member Data Documentation

◆ initial_X_parameters

IonicInitialStateParameters IonicModelParameters::initial_X_parameters

protected

Parameters for the state variables.

◆ initial_Xg_parameters

IonicInitialStateParameters IonicModelParameters::initial_Xg_parameters

protected

Parameters for the gating variables.

◆ parameters

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

protected

Other parameters (i.e. other than initial conditions) are stored in a map as key-parameter pairs. Derived classes should add parameters to this map in their constructors by calling add_parameter.

◆ value_set

bool IonicModelParameters::value_set = false

protected

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

◆ vector_parameters

std::map<std::string, VectorParameter<double> > IonicModelParameters::vector_parameters

protected

Vector parameters are stored in a map as key-parameter pairs.

◆ xml_element_name

const std::string IonicModelParameters::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 Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IonicModelParameters()

Member Function Documentation

◆ add_parameter() [1/2]

◆ add_parameter() [2/2]

◆ defined()

◆ get_initial_X()

◆ get_initial_Xg()

◆ get_scalar()

◆ get_vector()

◆ print_parameters()

◆ set_values()

Member Data Documentation

◆ initial_X_parameters

◆ initial_Xg_parameters

◆ parameters

◆ value_set

◆ vector_parameters

◆ xml_element_name