The OutputParameters class stores parameters for the Output XML element under Add_equation. More...

#include <Parameters.h>

Inheritance diagram for OutputParameters:

Public Member Functions
void	print_parameters ()

void	set_values (tinyxml2::XMLElement *xml_elem)

bool	get_output_value (const std::string &name)
	Get the value of an output by name. More...

std::string	get_alias_value (const std::string &name)
	Get the value of an alias by name. More...

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
Parameter< std::string >	type

std::vector< Parameter< bool > >	output_list

std::vector< Parameter< std::string > >	alias_list

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

Detailed Description

The OutputParameters class stores parameters for the Output XML element under Add_equation.

<Output type="Volume_integral" >
  <Temperature> true </Temperature>
</Output>

Member Function Documentation

◆ get_alias_value()

std::string OutputParameters::get_alias_value ( const std::string & name )

Get the value of an alias by name.

◆ get_output_value()

bool OutputParameters::get_output_value ( const std::string & name )

Get the value of an output by name.

Member Data Documentation

◆ xml_element_name_

const std::string OutputParameters::xml_element_name_ = "Output"

static

Define the XML element name for equation output parameters.

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

svFSI/Parameters.h
svFSI/Parameters.cpp

Public Member Functions