libMesh
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Attributes | Private Attributes | List of all members
libMesh::Parameters::Parameter< T > Class Template Reference

Concrete definition of a parameter value for a specified type. More...

#include <parameters.h>

Inheritance diagram for libMesh::Parameters::Parameter< T >:
[legend]

Public Member Functions

const T & get () const
 
T & set ()
 
virtual std::string type () const
 String identifying the type of parameter stored. More...
 
virtual void print (std::ostream &) const
 Prints the parameter value to the specified stream. More...
 
virtual Valueclone () const
 Clone this value. More...
 

Static Public Member Functions

static std::string get_info ()
 Gets a string containing the reference information. More...
 
static void print_info (std::ostream &out=libMesh::out)
 Prints the reference information, by default to libMesh::out. More...
 
static unsigned int n_objects ()
 Prints the number of outstanding (created, but not yet destroyed) objects. More...
 
static void enable_print_counter_info ()
 Methods to enable/disable the reference counter output from print_info() More...
 
static void disable_print_counter_info ()
 

Protected Types

typedef std::map< std::string, std::pair< unsigned int, unsigned int > > Counts
 Data structure to log the information. More...
 

Protected Member Functions

void increment_constructor_count (const std::string &name)
 Increments the construction counter. More...
 
void increment_destructor_count (const std::string &name)
 Increments the destruction counter. More...
 

Static Protected Attributes

static Counts _counts
 Actually holds the data. More...
 
static Threads::atomic< unsigned int > _n_objects
 The number of objects. More...
 
static Threads::spin_mutex _mutex
 Mutual exclusion object to enable thread-safe reference counting. More...
 
static bool _enable_print_counter
 Flag to control whether reference count information is printed when print_info is called. More...
 

Private Attributes

_value
 Stored parameter value. More...
 

Detailed Description

template<typename T>
class libMesh::Parameters::Parameter< T >

Concrete definition of a parameter value for a specified type.

Definition at line 201 of file parameters.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts
protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

Member Function Documentation

◆ clone()

template<typename T >
Parameters::Value * libMesh::Parameters::Parameter< T >::clone ( ) const
virtual

Clone this value.

Useful in copy-construction.

Implements libMesh::Parameters::Value.

Definition at line 302 of file parameters.h.

References libMesh::Parameters::Parameter< T >::_value.

303 {
304  Parameter<T> * copy = new Parameter<T>;
305 
306  libmesh_assert(copy);
307 
308  copy->_value = _value;
309 
310  return copy;
311 }
T _value
Stored parameter value.
Definition: parameters.h:236

◆ disable_print_counter_info()

static void libMesh::ReferenceCounter::disable_print_counter_info ( )
staticinherited

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )
staticinherited

Methods to enable/disable the reference counter output from print_info()

◆ get()

template<typename T>
const T& libMesh::Parameters::Parameter< T >::get ( ) const
Returns
A read-only reference to the parameter value.

Definition at line 208 of file parameters.h.

References libMesh::Parameters::Parameter< T >::_value.

208 { return _value; }
T _value
Stored parameter value.
Definition: parameters.h:236

◆ get_info()

static std::string libMesh::ReferenceCounter::get_info ( )
staticinherited

Gets a string containing the reference information.

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name)
protectedinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

182 {
183  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
184  std::pair<unsigned int, unsigned int> & p = _counts[name];
185 
186  p.first++;
187 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name)
protectedinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

195 {
196  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
197  std::pair<unsigned int, unsigned int> & p = _counts[name];
198 
199  p.second++;
200 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )
staticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

◆ print()

template<typename T >
void libMesh::Parameters::Parameter< T >::print ( std::ostream &  os) const
virtual

Prints the parameter value to the specified stream.

Implements libMesh::Parameters::Value.

Definition at line 294 of file parameters.h.

References libMesh::print_helper().

295 {
296  // Call helper function overloaded for basic scalar and vector types
297  print_helper(os, static_cast<const T *>(&_value));
298 }
void print_helper(std::ostream &os, const P *param)
Helper functions for printing scalar, vector and vector<vector> types.
Definition: parameters.h:534
T _value
Stored parameter value.
Definition: parameters.h:236

◆ print_info()

static void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out)
staticinherited

Prints the reference information, by default to libMesh::out.

◆ set()

template<typename T>
T& libMesh::Parameters::Parameter< T >::set ( )
Returns
A writable reference to the parameter value.

Definition at line 213 of file parameters.h.

References libMesh::Parameters::Parameter< T >::_value.

213 { return _value; }
T _value
Stored parameter value.
Definition: parameters.h:236

◆ type()

template<typename T >
std::string libMesh::Parameters::Parameter< T >::type ( ) const
virtual

String identifying the type of parameter stored.

Implements libMesh::Parameters::Value.

Definition at line 286 of file parameters.h.

References libMesh::demangle(), and libMesh::Quality::name().

287 {
288  return demangle(typeid(T).name());
289 }
std::string name(const ElemQuality q)
std::string demangle(const char *name)
Mostly system independent demangler.

Member Data Documentation

◆ _counts

Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter
staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex
staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

Threads::atomic<unsigned int> libMesh::ReferenceCounter::_n_objects
staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _value

template<typename T>
T libMesh::Parameters::Parameter< T >::_value
private

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