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 ()=default
	Special functions. More...
	RBTheta (RBTheta &&)=default
	RBTheta (const RBTheta &)=default
RBTheta &	operator= (const RBTheta &)=default
RBTheta &	operator= (RBTheta &&)=default
virtual	~RBTheta ()=default
virtual Number	evaluate (const RBParameters &)
	Evaluate the functor object for the given parameter. More...
virtual std::vector< Number >	evaluate_vec (const std::vector< RBParameters > &mus)

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

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 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 119 of file reference_counter.h.

Constructor & Destructor Documentation

RBTheta() [1/3]

libMesh::RBTheta::RBTheta ( )

default

Special functions.

This class holds no data so everything can be defaulted.

RBTheta() [2/3]

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

default

RBTheta() [3/3]

libMesh::RBTheta::RBTheta ( const RBTheta &  )

default

~RBTheta()

virtual libMesh::RBTheta::~RBTheta ( )

virtualdefault

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::RBTheta::evaluate ( const RBParameters &  mu )

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, ThetaPointLoadX, ThetaA2, ThetaF2, ThetaF1, ThetaF0, ThetaA1, ThetaConstant, ThetaA2, ThetaOutput0, ThetaA1, ThetaF0, ThetaA0, libMesh::RBEIMTheta, ThetaA3, ThetaA0, ThetaA2, ThetaA1, ThetaA0, ThetaA2, ThetaA2, ThetaA1, ThetaA1, ThetaA0, and ThetaA0.

Definition at line 28 of file rb_theta.C.

References libMesh::RBParameters::n_samples().

{
  // The RBTheta::evaluate() API is not general enough to handle the
  // multi-sample RBParameters case, and you must therefore call
  // RBTheta::evaluate_vec() instead.
  libmesh_error_msg_if(mu.n_samples() > 1,
                       "You should only call the evaluate_vec() API when using multi-sample RBParameters objects.");

  return 1.;
}

evaluate_vec()

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

virtual

Reimplemented in ThetaConstant, and libMesh::RBEIMTheta.

Definition at line 40 of file rb_theta.C.

{
  // Eventual return value
  std::vector<Number> result;

  for (const auto & mu : mus)
    {
      // Backwards-compatible behavior: for single-sample RBParameters objects, we fall back on
      // calling the scalar evaluate() function for this RBTheta object, which may have been
      // overridden by the user.
      if (mu.n_samples() == 1)
        result.push_back( this->evaluate(mu) );
      else
        {
          // For multi-sample RBParameters objects, all we can do is return
          // mu.n_samples() copies of 1 here at the base class level.
          result.insert(result.end(), /*count=*/mu.n_samples(), /*val=*/1.);
        }
    }

  return result;
}

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]

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

default

operator=() [2/2]

RBTheta& libMesh::RBTheta::operator= ( RBTheta &&  )

default

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

---

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

• include/reduced_basis/rb_theta.h
• src/reduced_basis/rb_theta.C