libMesh::RBEIMTheta Class Reference

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:

Public Member Functions
	RBEIMTheta (RBEIMEvaluation &rb_eim_eval_in, unsigned int index_in)
	Constructor. More...
	RBEIMTheta (RBEIMTheta &&)=default
	Special functions. More...
	RBEIMTheta (const RBEIMTheta &)=default
RBEIMTheta &	operator= (const RBEIMTheta &)=delete
RBEIMTheta &	operator= (RBEIMTheta &&)=delete
	~RBEIMTheta ()=default
virtual Number	evaluate (const RBParameters &mu) override
	Evaluate this RBEIMTheta object at the parameter mu. More...
virtual std::vector< Number >	evaluate_vec (const std::vector< RBParameters > &mus) override
	Evaluate this RBEIMTheta at all parameters in mus. 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_stream=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) noexcept
	Increments the construction counter. More...
void	increment_destructor_count (const std::string &name) noexcept
	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 119 of file reference_counter.h.

Constructor & Destructor Documentation

RBEIMTheta() [1/3]

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)
{
}

RBEIMTheta() [2/3]

libMesh::RBEIMTheta::RBEIMTheta ( RBEIMTheta &&  )

default

Special functions.

This class contains a reference, so it can't be default copy/move-assigned.

RBEIMTheta() [3/3]

libMesh::RBEIMTheta::RBEIMTheta ( const RBEIMTheta &  )

default

~RBEIMTheta()

libMesh::RBEIMTheta::~RBEIMTheta ( )

default

Member Function Documentation

disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = false;
  return;
}

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 94 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = true;
  return;
}

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.

References evaluate_vec().

{
  std::vector<RBParameters> mus {mu};
  std::vector<Number> values = evaluate_vec(mus);

  libmesh_error_msg_if(values.size() != 1, "Error: should have one value");
  return values[0];
}

evaluate_vec()

std::vector< Number > libMesh::RBEIMTheta::evaluate_vec ( const std::vector< RBParameters > &  mus )

overridevirtual

Evaluate this RBEIMTheta at all parameters in mus.

Reimplemented from libMesh::RBTheta.

Definition at line 43 of file rb_eim_theta.C.

References libMesh::RBEIMEvaluation::get_n_basis_functions(), libMesh::RBEIMEvaluation::get_rb_eim_solutions_entries(), index, rb_eim_eval, libMesh::RBEIMEvaluation::rb_eim_solves(), and libMesh::RBEIMEvaluation::set_eim_error_indicator_active().

Referenced by evaluate().

{
  rb_eim_eval.set_eim_error_indicator_active(true);
  rb_eim_eval.rb_eim_solves(mus, rb_eim_eval.get_n_basis_functions());
  rb_eim_eval.set_eim_error_indicator_active(false);

  return rb_eim_eval.get_rb_eim_solutions_entries(index);
}

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.

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

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

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)

  std::ostringstream oss;

  oss << '\n'
      << " ---------------------------------------------------------------------------- \n"
      << "| Reference count information                                                |\n"
      << " ---------------------------------------------------------------------------- \n";

  for (const auto & [name, cd] : _counts)
    oss << "| " << name << " reference count information:\n"
        << "|  Creations:    " << cd.first    << '\n'
        << "|  Destructions: " << cd.second << '\n';

  oss << " ---------------------------------------------------------------------------- \n";

  return oss.str();

#else

  return "";

#endif
}

increment_constructor_count()

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

inlineprotectednoexceptinherited

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.first++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_constructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

increment_destructor_count()

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

inlineprotectednoexceptinherited

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.second++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_destructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

n_objects()

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

inlinestaticinherited

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

Definition at line 85 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

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

  { return _n_objects; }

operator=() [1/2]

RBEIMTheta& libMesh::RBEIMTheta::operator= ( const RBEIMTheta &  )

delete

operator=() [2/2]

RBEIMTheta& libMesh::RBEIMTheta::operator= ( RBEIMTheta &&  )

delete

print_info()

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

staticinherited

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

Definition at line 81 of file reference_counter.C.

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

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

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

Member Data Documentation

_counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

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

_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 143 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 137 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 132 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 83 of file rb_eim_theta.h.

Referenced by evaluate_vec().

rb_eim_eval

RBEIMEvaluation& libMesh::RBEIMTheta::rb_eim_eval

The RBEIMEvaluation object that this RBEIMTheta is based on.

Definition at line 77 of file rb_eim_theta.h.

Referenced by evaluate_vec().

---

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