libMesh::RBEIMAssembly Class Reference

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

#include <rb_eim_assembly.h>

Inheritance diagram for libMesh::RBEIMAssembly:

Public Member Functions
	RBEIMAssembly (RBEIMConstruction &rb_eim_eval_in, unsigned int basis_function_index_in)
	Constructor. More...
	RBEIMAssembly (RBEIMAssembly &&)=default
	Special functions. More...
	RBEIMAssembly (const RBEIMAssembly &)=default
RBEIMAssembly &	operator= (const RBEIMAssembly &)=delete
RBEIMAssembly &	operator= (RBEIMAssembly &&)=delete
virtual	~RBEIMAssembly ()
void	evaluate_basis_function (dof_id_type elem_id, unsigned int var, std::vector< Number > &values)
	Return the basis function values for all quadrature points for variable var on element elem_id. More...
void	evaluate_side_basis_function (dof_id_type elem_id, unsigned int side_index, unsigned int var, std::vector< Number > &values)
	Same as evaluate_basis_function() except for side data. More...
Number	evaluate_node_basis_function (dof_id_type node_id, unsigned int var)
	Same as evaluate_basis_function() except for side data. More...
RBEIMConstruction &	get_rb_eim_construction ()
	Get a reference to the RBEIMEvaluation object. More...
virtual void	interior_assembly (FEMContext &)
	Perform the element interior assembly. More...
virtual void	boundary_assembly (FEMContext &)
	Perform the element boundary assembly. More...
virtual void	get_nodal_values (std::vector< dof_id_type > &, DenseMatrix< Number > &, DenseVector< Number > &, const System &, const Node &)
	Get values to add to the matrix or rhs vector based on node. 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 ()

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

Private Attributes
RBEIMConstruction &	_rb_eim_con
	The RBEIMConstruction that the assembly data comes from. More...
unsigned int	_basis_function_index
	The EIM basis function index (from _rb_eim_con's RBEIMEvaluation) for this assembly object. More...

Detailed Description

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

Author

David J. Knezevic

Date

2012

Definition at line 48 of file rb_eim_assembly.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

RBEIMAssembly() [1/3]

libMesh::RBEIMAssembly::RBEIMAssembly	(	RBEIMConstruction &	rb_eim_eval_in,
		unsigned int	basis_function_index_in
	)

Constructor.

Definition at line 34 of file rb_eim_assembly.C.

  :
  _rb_eim_con(rb_eim_con),
  _basis_function_index(basis_function_index_in)
{
}

RBEIMAssembly() [2/3]

libMesh::RBEIMAssembly::RBEIMAssembly ( RBEIMAssembly &&  )

default

Special functions.

• This class contains a reference, so it can't be default copy/move-assigned.
• The destructor is defaulted out of line.

RBEIMAssembly() [3/3]

libMesh::RBEIMAssembly::RBEIMAssembly ( const RBEIMAssembly &  )

default

~RBEIMAssembly()

libMesh::RBEIMAssembly::~RBEIMAssembly ( )

virtualdefault

Member Function Documentation

boundary_assembly()

virtual void libMesh::ElemAssembly::boundary_assembly ( FEMContext &  )

inlinevirtualinherited

Perform the element boundary assembly.

Reimplemented in Output0, F0, A3, A2, AssemblyF2, AssemblyA2, AssemblyF1, AssemblyF0, AssemblyA1, and AssemblyA0.

Definition at line 60 of file elem_assembly.h.

Referenced by libMesh::RBConstruction::add_scaled_matrix_and_vector().

{ }

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

void libMesh::RBEIMAssembly::evaluate_basis_function	(	dof_id_type	elem_id,
		unsigned int	var,
		std::vector< Number > &	values
	)

Return the basis function values for all quadrature points for variable var on element elem_id.

Definition at line 44 of file rb_eim_assembly.C.

References _basis_function_index, libMesh::RBEIMEvaluation::get_eim_basis_function_values_at_qps(), get_rb_eim_construction(), and libMesh::RBEIMConstruction::get_rb_eim_evaluation().

Referenced by EIM_F::interior_assembly(), and AssemblyEIM::interior_assembly().

{
  get_rb_eim_construction().get_rb_eim_evaluation().get_eim_basis_function_values_at_qps(
    _basis_function_index, elem_id, comp, values);

  libmesh_error_msg_if(values.empty(), "Error: EIM basis function has no entries on this element for this processor");
}

evaluate_node_basis_function()

Number libMesh::RBEIMAssembly::evaluate_node_basis_function	(	dof_id_type	node_id,
		unsigned int	var
	)

Same as evaluate_basis_function() except for side data.

Definition at line 65 of file rb_eim_assembly.C.

References _basis_function_index, libMesh::RBEIMEvaluation::get_eim_basis_function_node_local_value(), get_rb_eim_construction(), and libMesh::RBEIMConstruction::get_rb_eim_evaluation().

{
  return get_rb_eim_construction().get_rb_eim_evaluation().get_eim_basis_function_node_local_value(
    _basis_function_index, node_id, comp);
}

evaluate_side_basis_function()

void libMesh::RBEIMAssembly::evaluate_side_basis_function	(	dof_id_type	elem_id,
		unsigned int	side_index,
		unsigned int	var,
		std::vector< Number > &	values
	)

Same as evaluate_basis_function() except for side data.

Definition at line 54 of file rb_eim_assembly.C.

References _basis_function_index, libMesh::RBEIMEvaluation::get_eim_basis_function_side_values_at_qps(), get_rb_eim_construction(), and libMesh::RBEIMConstruction::get_rb_eim_evaluation().

{
  get_rb_eim_construction().get_rb_eim_evaluation().get_eim_basis_function_side_values_at_qps(
    _basis_function_index, elem_id, side_index, comp, values);

  libmesh_error_msg_if(values.empty(), "Error: EIM basis function has no entries on this element for this processor");
}

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
}

get_nodal_values()

virtual void libMesh::ElemAssembly::get_nodal_values ( std::vector< dof_id_type > &  , DenseMatrix< Number > &  , DenseVector< Number > &  , const System &  , const Node &    )

inlinevirtualinherited

Get values to add to the matrix or rhs vector based on node.

This allows one to impose point loads or springs, for example.

Definition at line 67 of file elem_assembly.h.

Referenced by libMesh::RBConstruction::add_scaled_matrix_and_vector().

  {
    // Do nothing by default
  }

get_rb_eim_construction()

RBEIMConstruction & libMesh::RBEIMAssembly::get_rb_eim_construction

(

)

Get a reference to the RBEIMEvaluation object.

Definition at line 72 of file rb_eim_assembly.C.

References _rb_eim_con.

Referenced by evaluate_basis_function(), evaluate_node_basis_function(), and evaluate_side_basis_function().

{
  return _rb_eim_con;
}

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

interior_assembly()

virtual void libMesh::ElemAssembly::interior_assembly ( FEMContext &  )

inlinevirtualinherited

Perform the element interior assembly.

Reimplemented in Ex6InnerProduct, AssemblyF1, AssemblyF0, OutputAssembly, InnerProductAssembly, AssemblyEIM, OutputAssembly, EIM_F, OutputAssembly, F0, EIM_IP_assembly, OutputAssembly, F0, A1, A2, A0, F0, A2, A0, AssemblyA2, A1, A2, A1, AssemblyA1, AcousticsInnerProduct, AssemblyA0, A0, A1, A0, M0, A0, and B.

Definition at line 55 of file elem_assembly.h.

Referenced by libMesh::RBConstruction::add_scaled_matrix_and_vector().

{ }

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]

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

delete

operator=() [2/2]

RBEIMAssembly& libMesh::RBEIMAssembly::operator= ( RBEIMAssembly &&  )

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

_basis_function_index

unsigned int libMesh::RBEIMAssembly::_basis_function_index

private

The EIM basis function index (from _rb_eim_con's RBEIMEvaluation) for this assembly object.

Definition at line 107 of file rb_eim_assembly.h.

Referenced by evaluate_basis_function(), evaluate_node_basis_function(), and evaluate_side_basis_function().

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

_rb_eim_con

RBEIMConstruction& libMesh::RBEIMAssembly::_rb_eim_con

private

The RBEIMConstruction that the assembly data comes from.

Definition at line 102 of file rb_eim_assembly.h.

Referenced by get_rb_eim_construction().

---

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

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