libMesh::RBParameters Class Reference

#include <rb_parameters.h>

Public Types

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

Public Member Functions

 RBParameters ()
 
void clear ()
 
Real get_value (const std::string &param_name) const
 
void set_value (const std::string &param_name, Real value)
 
unsigned int n_parameters () const
 
void get_parameter_names (std::set< std::string > &param_names) const
 
const_iterator begin () const
 
const_iterator end () const
 
bool operator== (const RBParameters &rhs) const
 
bool operator!= (const RBParameters &node) const
 
std::string get_string (unsigned int precision=6) const
 
void print () const
 

Private Attributes

std::map< std::string, Real_parameters
 

Detailed Description

This class is part of the rbOOmit framework.

This class defines a set of parameters index by strings.

Author
David J. Knezevic, 2012

Definition at line 43 of file rb_parameters.h.

Member Typedef Documentation

Definition at line 53 of file rb_parameters.h.

Constructor & Destructor Documentation

libMesh::RBParameters::RBParameters ( )

Constructor.

Member Function Documentation

const_iterator libMesh::RBParameters::begin ( ) const

Get a constant iterator to beginning of this RBParameters object.

void libMesh::RBParameters::clear ( )

Clear this object.

const_iterator libMesh::RBParameters::end ( ) const

Get a constant iterator to the end of this RBParameters object.

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

Fill param_names with the names of the parameters.

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.

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

Get the value of the specific parameter.

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

Get the number of parameters that have been added.

bool libMesh::RBParameters::operator!= ( const RBParameters node) const
Returns
!(*this == rhs).
bool libMesh::RBParameters::operator== ( const RBParameters rhs) const

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

void libMesh::RBParameters::print ( ) const

Print the parameters.

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

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

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

Definition at line 118 of file rb_parameters.h.


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

Site Created By: libMesh Developers
Last modified: February 07 2014 16:57:30 UTC

Hosted By:
SourceForge.net Logo