DomainParameters Class Reference

The DomainParameters class stores parameters for the XML 'Domain' element to specify properties for solving equations. More...

#include <Parameters.h>

Inheritance diagram for DomainParameters:

Public Member Functions
void	print_parameters ()
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. More...
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 (const std::string &name, const std::string &value)
	Set the value of a paramter from a string. More...
void	check_required ()
	Check if any required parameters have not been set. More...
std::map< std::string, std::string >	get_parameter_list ()
	Get the defined parameters as a map of strings. More...
void	print_parameter_list ()
	Print the parameters. More...

Public Attributes
ConstitutiveModelParameters	constitutive_model
FiberReinforcementStressParameters	fiber_reinforcement_stress
StimulusParameters	stimulus
FluidViscosityParameters	fluid_viscosity
SolidViscosityParameters	solid_viscosity
Parameter< std::string >	id
Parameter< double >	absolute_tolerance
VectorParameter< double >	anisotropic_conductivity
Parameter< double >	backflow_stabilization_coefficient
Parameter< double >	conductivity
Parameter< double >	continuity_stabilization_coefficient
Parameter< double >	density
Parameter< std::string >	dilational_penalty_model
Parameter< std::string >	equation
Parameter< double >	elasticity_modulus
Parameter< std::string >	electrophysiology_model
Parameter< double >	feedback_parameter_for_stretch_activated_currents
Parameter< double >	fluid_density
Parameter< double >	force_x
Parameter< double >	force_y
Parameter< double >	force_z
Parameter< double >	isotropic_conductivity
Parameter< double >	mass_damping
Parameter< int >	maximum_iterations
Parameter< double >	momentum_stabilization_coefficient
Parameter< std::string >	myocardial_zone
Parameter< double >	G_Na
Parameter< double >	G_CaL
Parameter< double >	G_Kr
Parameter< double >	G_Ks
Parameter< double >	G_to
Parameter< double >	tau_fi
Parameter< double >	tau_si
Parameter< std::string >	ode_solver
Parameter< double >	penalty_parameter
Parameter< double >	poisson_ratio
Parameter< double >	relative_tolerance
Parameter< double >	shell_thickness
Parameter< double >	solid_density
Parameter< double >	source_term
Parameter< double >	time_step_for_integration
Parameter< double >	inverse_darcy_permeability
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. More...
std::string	xml_element_name = ""

Static Public Attributes
static const std::string	xml_element_name_ = "Domain"
	Define the XML element name for domain parameters. More...

Detailed Description

The DomainParameters class stores parameters for the XML 'Domain' element to specify properties for solving equations.

<Domain id="1" >
  <Equation> fluid </Equation>
  <Density> 1.06 </Density>
  <Viscosity model="Constant" >
    <Value> 0.04 </Value>
  </Viscosity>
  <Backflow_stabilization_coefficient> 0.2 </Backflow_stabilization_coefficient>
</Domain>

Member Data Documentation

xml_element_name_

const std::string DomainParameters::xml_element_name_ = "Domain"

static

Define the XML element name for domain parameters.

---

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

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