This class is part of the rbOOmit framework. More...

#include <rb_parameters.h>

Public Types
typedef std::map< std::string, Real >::const_iterator	const_iterator

Public Member Functions
	RBParameters ()=default
	The special functions can be defaulted for this class, as it does not manage any memory itself. More...

	RBParameters (RBParameters &&)=default

	RBParameters (const RBParameters &)=default

RBParameters &	operator= (const RBParameters &)=default

RBParameters &	operator= (RBParameters &&)=default

	~RBParameters ()=default

	RBParameters (const std::map< std::string, Real > &parameter_map)
	Constructor. More...

void	clear ()
	Clear this object. More...

Real	get_value (const std::string &param_name) const
	Get the value of the specific parameter. More...

void	set_value (const std::string &param_name, Real value)
	Set the value of the specified parameter. More...

Real	get_extra_value (const std::string &param_name) const
	Get the value of the specific extra parameter. More...

void	set_extra_value (const std::string &param_name, Real value)
	Set the value of the specified extra parameter. More...

unsigned int	n_parameters () const
	Get the number of parameters that have been added. More...

void	get_parameter_names (std::set< std::string > &param_names) const
	Fill `param_names` with the names of the parameters. More...

void	get_extra_parameter_names (std::set< std::string > &param_names) const
	Fill `param_names` with the names of the extra parameters. More...

const_iterator	begin () const
	Get const_iterator access to the parameters stored in this RBParameters object. More...

const_iterator	end () const

const_iterator	extra_begin () const
	Get const_iterator access to the extra parameters stored in this RBParameters object. More...

const_iterator	extra_end () const

bool	operator== (const RBParameters &rhs) const
	Two RBParameters are equal if they have the same _parameters map. More...

bool	operator!= (const RBParameters &node) const

std::string	get_string (unsigned int precision=6) const
	Get a string that specifies the contents of this RBParameters object. More...

void	print () const
	Print the parameters. More...

Private Attributes
std::map< std::string, Real >	_parameters
	The map that stores the actual parameters, indexed by names. More...

std::map< std::string, Real >	_extra_parameters
	The map that stores extra parameters not used for RB training, indexed by names. More...

Detailed Description

This class is part of the rbOOmit framework.

This class defines a set of parameters index by strings.

Author: David J. Knezevic

Date: 2012

Definition at line 42 of file rb_parameters.h.

Member Typedef Documentation

◆ const_iterator

typedef std::map<std::string, Real>::const_iterator libMesh::RBParameters::const_iterator

Definition at line 63 of file rb_parameters.h.

Constructor & Destructor Documentation

◆ RBParameters() [1/4]

libMesh::RBParameters::RBParameters ( )

default

The special functions can be defaulted for this class, as it does not manage any memory itself.

◆ RBParameters() [2/4]

libMesh::RBParameters::RBParameters ( RBParameters && )

default

◆ RBParameters() [3/4]

libMesh::RBParameters::RBParameters ( const RBParameters & )

default

◆ ~RBParameters()

libMesh::RBParameters::~RBParameters ( )

default

◆ RBParameters() [4/4]

libMesh::RBParameters::RBParameters ( const std::map< std::string, Real > & parameter_map )

Constructor.

Set parameters based on the std::map parameter_map.

Member Function Documentation

◆ begin()

const_iterator libMesh::RBParameters::begin ( ) const

Get const_iterator access to the parameters stored in this RBParameters object.

◆ clear()

void libMesh::RBParameters::clear ( )

Clear this object.

◆ end()

const_iterator libMesh::RBParameters::end ( ) const

◆ extra_begin()

const_iterator libMesh::RBParameters::extra_begin ( ) const

Get const_iterator access to the extra parameters stored in this RBParameters object.

◆ extra_end()

const_iterator libMesh::RBParameters::extra_end ( ) const

◆ get_extra_parameter_names()

void libMesh::RBParameters::get_extra_parameter_names ( std::set< std::string > & param_names ) const

Fill param_names with the names of the extra parameters.

◆ get_extra_value()

Real libMesh::RBParameters::get_extra_value ( const std::string & param_name ) const

Get the value of the specific extra parameter.

◆ get_parameter_names()

void libMesh::RBParameters::get_parameter_names ( std::set< std::string > & param_names ) const

Fill param_names with the names of the parameters.

◆ get_string()

std::string libMesh::RBParameters::get_string ( unsigned int precision = 6 ) const

Get a string that specifies the contents of this RBParameters object.

precision specifies the number of digits of precision we use in scientific notation in the string.

◆ get_value()

Real libMesh::RBParameters::get_value ( const std::string & param_name ) const

Get the value of the specific parameter.

Referenced by ThetaA1::evaluate(), ThetaA2::evaluate(), ShiftedGaussian::evaluate(), Gx::evaluate(), Gy::evaluate(), ThetaA3::evaluate(), Gz::evaluate(), ThetaA0::evaluate(), ThetaF0::evaluate(), ThetaF1::evaluate(), ThetaF2::evaluate(), ThetaPointLoadX::evaluate(), ThetaPointLoadY::evaluate(), ThetaPointLoadZ::evaluate(), and ThetaEIM::evaluate().

◆ n_parameters()

unsigned int libMesh::RBParameters::n_parameters ( ) const

Get the number of parameters that have been added.

◆ operator!=()

bool libMesh::RBParameters::operator!= ( const RBParameters & node ) const

Returns: !(*this == rhs).

◆ operator=() [1/2]

RBParameters& libMesh::RBParameters::operator= ( const RBParameters & )

default

◆ operator=() [2/2]

RBParameters& libMesh::RBParameters::operator= ( RBParameters && )

default

◆ operator==()

bool libMesh::RBParameters::operator== ( const RBParameters & rhs ) const

Two RBParameters are equal if they have the same _parameters map.

◆ print()

void libMesh::RBParameters::print ( ) const

Print the parameters.

◆ set_extra_value()

void libMesh::RBParameters::set_extra_value	(	const std::string &	param_name,
		Real	value
	)

Set the value of the specified extra parameter.

If param_name doesn't already exist, it is added to the extra parameters.

◆ set_value()

void libMesh::RBParameters::set_value	(	const std::string &	param_name,
		Real	value
	)

Set the value of the specified parameter.

If param_name doesn't already exist, it is added to the RBParameters object.

Member Data Documentation

◆ _extra_parameters

std::map<std::string, Real> libMesh::RBParameters::_extra_parameters

private

The map that stores extra parameters not used for RB training, indexed by names.

Definition at line 151 of file rb_parameters.h.

◆ _parameters

std::map<std::string, Real> libMesh::RBParameters::_parameters

private

The map that stores the actual parameters, indexed by names.

Definition at line 146 of file rb_parameters.h.

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

include/reduced_basis/rb_parameters.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

Constructor & Destructor Documentation

◆ RBParameters() [1/4]

◆ RBParameters() [2/4]

◆ RBParameters() [3/4]

◆ ~RBParameters()

◆ RBParameters() [4/4]

Member Function Documentation

◆ begin()

◆ clear()

◆ end()

◆ extra_begin()

◆ extra_end()

◆ get_extra_parameter_names()

◆ get_extra_value()

◆ get_parameter_names()

◆ get_string()

◆ get_value()

◆ n_parameters()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ print()

◆ set_extra_value()

◆ set_value()

Member Data Documentation

◆ _extra_parameters

◆ _parameters