RISProjectionParameters Class Reference

The RISProjectionParameters class stores parameters for the 'Add_RIS_projection' XML element used for RIS valve simulations. More...

#include <Parameters.h>

Inheritance diagram for RISProjectionParameters:

Public Member Functions
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.
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 ()
	Get the defined parameters as a map of strings.
void	print_parameter_list ()
	Print the parameters.

Public Attributes
Parameter< std::string >	name
Parameter< std::string >	project_from_face
Parameter< double >	resistance
Parameter< double >	projection_tolerance
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 = ""

Static Public Attributes
static const std::string	xml_element_name_ = "Add_RIS_projection"
	Define the XML element name for mesh parameters.

Detailed Description

The RISProjectionParameters class stores parameters for the 'Add_RIS_projection' XML element used for RIS valve simulations.

<Add_RIS_projection name="left_ris" >
  <Project_from_face> right_ris </Project_from_face>
  <Resistance> 1.e6 </Resistance>
</Add_RIS_projection>

Member Data Documentation

xml_element_name_

const std::string RISProjectionParameters::xml_element_name_ = "Add_RIS_projection"

static

Define the XML element name for mesh parameters.

---

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

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