The LinearSolverParameters class stores parameters for the 'LS' XML element. More...

#include <Parameters.h>

Inheritance diagram for LinearSolverParameters:

Public Member Functions
void	print_parameters ()

void	set_values (tinyxml2::XMLElement *fsi_file)

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 (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 >	type

Parameter< double >	absolute_tolerance

Parameter< int >	krylov_space_dimension

Parameter< int >	max_iterations

Parameter< int >	ns_cg_max_iterations

Parameter< double >	ns_cg_tolerance

Parameter< int >	ns_gm_max_iterations

Parameter< double >	ns_gm_tolerance

Parameter< double >	tolerance

LinearAlgebraParameters	linear_algebra

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_ = "LS"
	Define the XML element name for equation output parameters.

Detailed Description

The LinearSolverParameters class stores parameters for the 'LS' XML element.

Member Data Documentation

const std::string LinearSolverParameters::xml_element_name_ = "LS"

static

Define the XML element name for equation output parameters.

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