libMesh::RBParameters Class Reference

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.

Definition at line 30 of file rb_parameters.C.

{
  _parameters = parameter_map;
}

References _parameters.

Member Function Documentation

begin()

RBParameters::const_iterator libMesh::RBParameters::begin

(

)

const

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

Definition at line 89 of file rb_parameters.C.

{
  return _parameters.begin();
}

References _parameters.

Referenced by libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_deterministic().

clear()

void libMesh::RBParameters::clear

(

)

Clear this object.

Definition at line 35 of file rb_parameters.C.

{
  _parameters.clear();
  _extra_parameters.clear();
}

References _extra_parameters, and _parameters.

Referenced by libMesh::RBParametrized::clear(), and libMesh::RBParametrized::RBParametrized().

end()

RBParameters::const_iterator libMesh::RBParameters::end

(

)

const

Definition at line 94 of file rb_parameters.C.

{
  return _parameters.end();
}

References _parameters.

extra_begin()

RBParameters::const_iterator libMesh::RBParameters::extra_begin

(

)

const

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

Definition at line 99 of file rb_parameters.C.

{
  return _extra_parameters.begin();
}

References _extra_parameters.

extra_end()

RBParameters::const_iterator libMesh::RBParameters::extra_end

(

)

const

Definition at line 104 of file rb_parameters.C.

{
  return _extra_parameters.end();
}

References _extra_parameters.

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.

Definition at line 81 of file rb_parameters.C.

{
  param_names.clear();
 
  for (const auto & pr : _extra_parameters)
    param_names.insert(pr.first);
}

References _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.

Definition at line 52 of file rb_parameters.C.

{
  // find the parameter value, throwing an error if it doesn't exist.
  return libmesh_map_find(_extra_parameters, param_name);
}

References _extra_parameters.

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.

Definition at line 69 of file rb_parameters.C.

{
  param_names.clear();
 
  const_iterator it     = _parameters.begin();
  const_iterator it_end = _parameters.end();
  for ( ; it != it_end; ++it)
    {
      param_names.insert( it->first );
    }
}

References _parameters.

Referenced by libMesh::RBParametrized::get_parameter_names().

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.

Definition at line 120 of file rb_parameters.C.

{
  std::stringstream param_stringstream;
  param_stringstream.precision(precision);
 
  const_iterator it     = _parameters.begin();
  const_iterator it_end = _parameters.end();
  for ( ; it != it_end; ++it)
    {
      param_stringstream << it->first << ": " << std::scientific <<  it->second << std::endl;
    }
  return param_stringstream.str();
}

References _parameters.

Referenced by print().

get_value()

Real libMesh::RBParameters::get_value

(

const std::string &

param_name

)

const

Get the value of the specific parameter.

Definition at line 41 of file rb_parameters.C.

{
  // find the parameter value, throwing an error if it doesn't exist.
  return libmesh_map_find(_parameters, param_name);
}

References _parameters.

Referenced by libMesh::RBDataSerialization::add_parameter_ranges_to_builder(), libMesh::RBSCMConstruction::enrich_C_J(), ThetaA1::evaluate(), ThetaA2::evaluate(), ShiftedGaussian::evaluate(), Gx::evaluate(), libMesh::RBEIMTheta::evaluate(), Gy::evaluate(), ThetaA3::evaluate(), Gz::evaluate(), ThetaA0::evaluate(), ThetaF0::evaluate(), ThetaF1::evaluate(), ThetaF2::evaluate(), ThetaPointLoadX::evaluate(), ThetaPointLoadY::evaluate(), ThetaPointLoadZ::evaluate(), ThetaEIM::evaluate(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_deterministic(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_random(), libMesh::RBParametrized::get_parameter_max(), libMesh::RBParametrized::get_parameter_min(), libMesh::RBParametrized::initialize_parameters(), and scale_mesh_and_plot().

n_parameters()

unsigned int libMesh::RBParameters::n_parameters

(

)

const

Get the number of parameters that have been added.

Definition at line 63 of file rb_parameters.C.

{
  return cast_int<unsigned int>
    (_parameters.size());
}

References _parameters.

Referenced by libMesh::RBEIMTheta::evaluate(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_deterministic(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_random(), libMesh::RBParametrized::get_n_params(), libMesh::RBParametrized::initialize_parameters(), and libMesh::RBParametrized::valid_params().

operator!=()

bool libMesh::RBParameters::operator!=

(

const RBParameters &

node

)

const

Returns

!(*this == rhs).

Definition at line 115 of file rb_parameters.C.

{
  return !(*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.

Definition at line 109 of file rb_parameters.C.

{
  return (this->_parameters == rhs._parameters &&
          this->_extra_parameters == rhs._extra_parameters);
}

References _extra_parameters, and _parameters.

print()

void libMesh::RBParameters::print

(

)

const

Print the parameters.

Definition at line 134 of file rb_parameters.C.

{
  libMesh::out << get_string() << std::endl;
}

References get_string(), and libMesh::out.

Referenced by libMesh::RBParametrized::print_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.

Definition at line 58 of file rb_parameters.C.

{
  _extra_parameters[param_name] = value;
}

References _extra_parameters, and value.

Referenced by libMesh::RBConstructionBase< CondensedEigenSystem >::get_params_from_training_set().

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.

Definition at line 47 of file rb_parameters.C.

{
  _parameters[param_name] = value;
}

References _parameters, and value.

Referenced by libMesh::RBEIMTheta::evaluate(), libMesh::RBConstructionBase< CondensedEigenSystem >::get_params_from_training_set(), libMesh::RBParametrized::initialize_parameters(), libMesh::RBDataDeserialization::load_parameter_ranges(), main(), libMesh::RBSCMConstruction::process_parameters_file(), libMesh::RBConstruction::process_parameters_file(), and libMesh::RBParametrized::read_parameter_ranges_from_file().

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.

Referenced by clear(), extra_begin(), extra_end(), get_extra_parameter_names(), get_extra_value(), operator==(), and set_extra_value().

_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.

Referenced by begin(), clear(), end(), get_parameter_names(), get_string(), get_value(), n_parameters(), operator==(), RBParameters(), and set_value().

---

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

• include/reduced_basis/rb_parameters.h
• src/reduced_basis/rb_parameters.C