This class provides functionality required to define an RBTheta object that arises from an "Empirical Interpolation Method" (EIM) approximation. More...

#include <rb_eim_theta.h>

Inheritance diagram for libMesh::RBEIMTheta:

[legend]

Public Member Functions
	RBEIMTheta (RBEIMEvaluation &rb_eim_eval_in, unsigned int index_in)
	Constructor. More...

virtual Number	evaluate (const RBParameters &mu) override
	Evaluate this RBEIMTheta object at the parameter `mu`. 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 ()

Public Attributes
RBEIMEvaluation &	rb_eim_eval
	The RBEIMEvaluation object that this RBEIMTheta is based on. More...

unsigned int	index
	The index of the RB_solution vector that we pick out from rb_eim_eval to provide the value of the evaluation. More...

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 = true
	Flag to control whether reference count information is printed when print_info is called. More...

Detailed Description

This class provides functionality required to define an RBTheta object that arises from an "Empirical Interpolation Method" (EIM) approximation.

Author: David J. Knezevic

Date: 2011

Definition at line 42 of file rb_eim_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

◆ RBEIMTheta()

libMesh::RBEIMTheta::RBEIMTheta	(	RBEIMEvaluation &	rb_eim_eval_in,
		unsigned int	index_in
	)

Constructor.

Definition at line 27 of file rb_eim_theta.C.

   :
   rb_eim_eval(rb_eim_eval_in),
   index(index_in)
 {
 }

Member Function Documentation

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

 {
   _enable_print_counter = false;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::LibMeshInit().

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

Definition at line 100 of file reference_counter.C.

 {
   _enable_print_counter = true;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

◆ evaluate()

Number libMesh::RBEIMTheta::evaluate ( const RBParameters & mu )

overridevirtual

Evaluate this RBEIMTheta object at the parameter mu.

This entails solving the RB EIM approximation and picking out the appropriate coefficient.

Reimplemented from libMesh::RBTheta.

Reimplemented in ThetaEIM.

Definition at line 34 of file rb_eim_theta.C.

 {
   if (mu.n_parameters() > rb_eim_eval.get_n_params())
     {
       // In this case the parameters related to the EIM are a subset of
       // the parameters from the associated RB problem, hence we need to "pull out"
       // the parameters related to the EIM
       RBParameters mu_eim;
       for (const auto & pr : rb_eim_eval.get_parameters())
         {
           const std::string & param_name = pr.first;
           mu_eim.set_value(param_name, mu.get_value(param_name));
         }
       rb_eim_eval.set_parameters(mu_eim);
     }
   else
     {
       rb_eim_eval.set_parameters(mu);
     }
  
   rb_eim_eval.rb_solve(rb_eim_eval.get_n_basis_functions());
  
   return rb_eim_eval.RB_solution(index);
 }

References libMesh::RBEvaluation::get_n_basis_functions(), libMesh::RBParametrized::get_n_params(), libMesh::RBParametrized::get_parameters(), libMesh::RBParameters::get_value(), index, libMesh::RBParameters::n_parameters(), rb_eim_eval, libMesh::RBEvaluation::RB_solution, libMesh::RBEIMEvaluation::rb_solve(), libMesh::RBParametrized::set_parameters(), and libMesh::RBParameters::set_value().

◆ get_info()

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

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
  
   std::ostringstream oss;
  
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
  
   for (const auto & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
  
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
  
   oss << " ---------------------------------------------------------------------------- \n";
  
   return oss.str();
  
 #else
  
   return "";
  
 #endif
 }

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

Referenced by libMesh::ReferenceCounter::print_info().

◆ increment_constructor_count()

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

inlineprotectedinherited

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.

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

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

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

◆ increment_destructor_count()

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

inlineprotectedinherited

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.

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

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

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

◆ n_objects()

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

inlinestaticinherited

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

Definition at line 83 of file reference_counter.h.

84 { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

◆ print_info()

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

staticinherited

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

Definition at line 87 of file reference_counter.C.

 {
   if (_enable_print_counter)
     out_stream << ReferenceCounter::get_info();
 }

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

Member Data Documentation

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

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

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

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

Definition at line 141 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

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

◆ index

unsigned int libMesh::RBEIMTheta::index

The index of the RB_solution vector that we pick out from rb_eim_eval to provide the value of the evaluation.

Definition at line 67 of file rb_eim_theta.h.

Referenced by evaluate().

◆ rb_eim_eval

RBEIMEvaluation& libMesh::RBEIMTheta::rb_eim_eval

The RBEIMEvaluation object that this RBEIMTheta is based on.

Definition at line 61 of file rb_eim_theta.h.

Referenced by evaluate().

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

include/reduced_basis/rb_eim_theta.h
src/reduced_basis/rb_eim_theta.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Counts

Constructor & Destructor Documentation

◆ RBEIMTheta()

Member Function Documentation

◆ disable_print_counter_info()

◆ enable_print_counter_info()

◆ evaluate()

◆ get_info()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ n_objects()

◆ print_info()

Member Data Documentation

◆ _counts

◆ _enable_print_counter

◆ _mutex

◆ _n_objects

◆ index

◆ rb_eim_eval