Parameters for coupling to the svZeroDSolver (0D lumped-parameter solver). More...

#include <Parameters.h>

Inheritance diagram for svZeroDSolverInterfaceParameters:

Public Member Functions
bool	defined () const

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 () const
	Get the defined parameters as a map of strings.

void	print_parameter_list ()
	Print the parameters.

Public Attributes
Parameter< std::string >	configuration_file

Parameter< std::string >	coupling_type

Parameter< double >	initial_flows

Parameter< double >	initial_pressures

Parameter< double >	finite_difference_absolute_perturbation

Parameter< double >	finite_difference_relative_perturbation

Parameter< std::string >	shared_library

bool	value_set = false

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_

Detailed Description

Parameters for coupling to the svZeroDSolver (0D lumped-parameter solver).

XML element:

<svZeroDSolver_interface>
  <Coupling_type> implicit </Coupling_type>
  <Configuration_file> svzerod_3Dcoupling.json </Configuration_file>
  <Shared_library> /path/to/libsvzero_interface </Shared_library>
  <Finite_difference_absolute_perturbation> 1.0e-7 </Finite_difference_absolute_perturbation>
  <Finite_difference_relative_perturbation> 1.0e-5 </Finite_difference_relative_perturbation>
</svZeroDSolver_interface>

Member Data Documentation

◆ xml_element_name_

const std::string svZeroDSolverInterfaceParameters::xml_element_name_

static

Initial value:

=

"svZeroDSolver_interface"

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

solver/Parameters.h
solver/Parameters.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Data Documentation

◆ xml_element_name_