libMesh::RBTheta Class Reference

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

#include <rb_theta.h>

Inheritance diagram for libMesh::RBTheta:

Public Member Functions
	RBTheta ()
	Constructor. More...
	RBTheta (RBTheta &&other) noexcept
	Move constructor, must be declared noexcept. More...
virtual	~RBTheta ()
	Destructor. More...
virtual Number	evaluate (const RBParameters &)
	Evaluate the functor object for the given parameter. 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...

Detailed Description

This class is part of the rbOOmit framework.

RBTheta provides a default functor class with which to define the parameter-dependent functions required for the PDE decomposition employed by the Reduced Basis method.

Author

David J. Knezevic

Date

2011

Definition at line 46 of file rb_theta.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.

Constructor & Destructor Documentation

RBTheta() [1/2]

libMesh::RBTheta::RBTheta

(

)

Constructor.

Initializes required data structures.

Definition at line 54 of file rb_theta.h.

{}

RBTheta() [2/2]

libMesh::RBTheta::RBTheta ( RBTheta &&  other )

noexcept

Move constructor, must be declared noexcept.

Definition at line 59 of file rb_theta.h.

    : ReferenceCountedObject<RBTheta>(std::move(other))
  {}

~RBTheta()

virtual libMesh::RBTheta::~RBTheta ( )

virtual

Destructor.

Definition at line 66 of file rb_theta.h.

{}

Member Function Documentation

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()

evaluate()

virtual Number libMesh::RBTheta::evaluate ( const RBParameters &  )

virtual

Evaluate the functor object for the given parameter.

Default implementation is to return 1, override to provide problem dependent behavior.

Reimplemented in ThetaF1, ThetaF0, ThetaEIM, ThetaPointLoadZ, ThetaPointLoadY, ThetaA2, ThetaPointLoadX, ThetaF2, ThetaF1, ThetaA1, ThetaF0, ThetaA2, ThetaA0, ThetaOutput0, ThetaA1, ThetaF0, ThetaA3, ThetaA0, ThetaA2, libMesh::RBEIMTheta, ThetaA0, ThetaA1, ThetaA0, ThetaA2, ThetaA2, ThetaA1, ThetaA1, ThetaA0, and ThetaA0.

Definition at line 73 of file rb_theta.h.

{ return 1.; }

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().

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int> & p = _counts[name];

  p.first++;
}

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().

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int> & p = _counts[name];

  p.second++;
}

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.

  { return _n_objects; }

print_info()

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

staticinherited

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

Member Data Documentation

_counts

Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

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

---

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

• include/reduced_basis/rb_theta.h