Parameters for coupling to the svOneDSolver (1D blood-flow solver). More...

#include <Parameters.h>

Inheritance diagram for svOneDSolverInterfaceParameters:

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 >	coupling_type

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 svOneDSolver (1D blood-flow solver).

XML element:

<svOneDSolver_interface>
  <Coupling_type> Implicit </Coupling_type>
  <Shared_library> /path/to/libsvoned_interface </Shared_library>
</svOneDSolver_interface>

Notes

Coupling_type: "Explicit" | "Implicit" | "Semi-implicit" Controls how the 3D Newton iteration couples to the 1D solver (same semantics as the 0D coupling_type). Shared_library: Path to the 1D interface shared library. The extension (.so or .dylib) may be omitted; it will be appended automatically based on the platform.

Each coupled face specifies its own input file via <Coupling_interface> <svOneDSolver_input_file> ... </svOneDSolver_input_file> </Coupling_interface> inside the corresponding <Add_BC> element.

Member Data Documentation

◆ xml_element_name_

const std::string svOneDSolverInterfaceParameters::xml_element_name_

static

Initial value:

=

"svOneDSolver_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

Notes

Member Data Documentation

◆ xml_element_name_