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_con_in, unsigned int basis_function_index_in)
	Constructor. More...
virtual	~RBEIMAssembly ()
	Destructor. More...
virtual void	evaluate_basis_function (unsigned int var, const Elem &element, const std::vector< Point > &points, std::vector< Number > &values)
	Evaluate variable var_number of this object's EIM basis function at the points points, where the points are in reference coordinates. More...
RBEIMConstruction &	get_rb_eim_construction ()
	Get a reference to the RBEIMConstruction object. More...
NumericVector< Number > &	get_ghosted_basis_function ()
	Get a reference to the ghosted_basis_function. More...
FEBase &	get_fe ()
	Retrieve the FE 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=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 = true
	Flag to control whether reference count information is printed when print_info is called. More...

Private Member Functions
void	initialize_fe ()
	Initialize the FE object. More...

Private Attributes
RBEIMConstruction &	_rb_eim_con
	The RBEIMConstruction object that this RBEIMAssembly is based on. More...
unsigned int	_basis_function_index
	The EIM basis function index (from rb_eim_eval) for this assembly object. More...
std::unique_ptr< NumericVector< Number > >	_ghosted_basis_function
	The basis function that we sample to evaluate the empirical interpolation approximation. More...
std::unique_ptr< FEBase >	_fe
	We store an FE object so we can easily reinit in evaluate_basis_function. 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 49 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 117 of file reference_counter.h.

Constructor & Destructor Documentation

RBEIMAssembly()

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

Constructor.

Definition at line 35 of file rb_eim_assembly.C.

  : _rb_eim_con(rb_eim_con_in),
    _basis_function_index(basis_function_index_in),
    _ghosted_basis_function(NumericVector<Number>::build(rb_eim_con_in.get_explicit_system().comm()))
{
  // localize the vector that stores the basis function for this assembly object,
  // i.e. the vector that is used in evaluate_basis_function_at_quad_pts
#ifdef LIBMESH_ENABLE_GHOSTED
  _ghosted_basis_function->init (_rb_eim_con.get_explicit_system().n_dofs(),
                                 _rb_eim_con.get_explicit_system().n_local_dofs(),
                                 _rb_eim_con.get_explicit_system().get_dof_map().get_send_list(),
                                 false,
                                 GHOSTED);
  _rb_eim_con.get_rb_evaluation().get_basis_function(_basis_function_index).
    localize(*_ghosted_basis_function,
             _rb_eim_con.get_explicit_system().get_dof_map().get_send_list());
#else
  _ghosted_basis_function->init (_rb_eim_con.get_explicit_system().n_dofs(), false, SERIAL);
  _rb_eim_con.get_rb_evaluation().get_basis_function(_basis_function_index).
    localize(*_ghosted_basis_function);
#endif
 
  initialize_fe();
}

References _basis_function_index, _ghosted_basis_function, _rb_eim_con, libMesh::RBEvaluation::get_basis_function(), libMesh::System::get_dof_map(), libMesh::RBEIMConstruction::get_explicit_system(), libMesh::RBConstruction::get_rb_evaluation(), libMesh::DofMap::get_send_list(), libMesh::GHOSTED, initialize_fe(), libMesh::System::n_dofs(), libMesh::System::n_local_dofs(), and libMesh::SERIAL.

~RBEIMAssembly()

libMesh::RBEIMAssembly::~RBEIMAssembly ( )

virtual

Destructor.

Definition at line 61 of file rb_eim_assembly.C.

{
}

Member Function Documentation

boundary_assembly()

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

inlinevirtualinherited

Perform the element boundary assembly.

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

Definition at line 62 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 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_basis_function()

void libMesh::RBEIMAssembly::evaluate_basis_function ( unsigned int  var, const Elem &  element, const std::vector< Point > &  points, std::vector< Number > &  values  )

virtual

Evaluate variable var_number of this object's EIM basis function at the points points, where the points are in reference coordinates.

Fill values with the basis function values.

Definition at line 65 of file rb_eim_assembly.C.

{
  LOG_SCOPE("evaluate_basis_function", "RBEIMAssembly");
 
  const std::vector<std::vector<Real>> & phi = get_fe().get_phi();
 
  // The FE object caches data, hence we recompute as little as
  // possible on the call to reinit.
  get_fe().reinit (&element, &points);
 
  std::vector<dof_id_type> dof_indices_var;
 
  DofMap & dof_map = get_rb_eim_construction().get_explicit_system().get_dof_map();
  dof_map.dof_indices (&element, dof_indices_var, var);
 
  libmesh_assert(dof_indices_var.size() == phi.size());
 
  unsigned int n_points = points.size();
  values.resize(n_points);
 
  for (unsigned int pt_index=0; pt_index<n_points; pt_index++)
    {
      values[pt_index] = 0.;
      for (auto i : index_range(dof_indices_var))
        values[pt_index] += (*_ghosted_basis_function)(dof_indices_var[i]) * phi[i][pt_index];
    }
}

References libMesh::DofMap::dof_indices(), libMesh::System::get_dof_map(), libMesh::RBEIMConstruction::get_explicit_system(), get_fe(), libMesh::FEGenericBase< OutputType >::get_phi(), get_rb_eim_construction(), libMesh::index_range(), libMesh::libmesh_assert(), and libMesh::FEAbstract::reinit().

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

get_fe()

FEBase & libMesh::RBEIMAssembly::get_fe

(

)

Retrieve the FE object.

Definition at line 106 of file rb_eim_assembly.C.

{
  return *_fe;
}

References _fe.

Referenced by evaluate_basis_function().

get_ghosted_basis_function()

NumericVector< Number > & libMesh::RBEIMAssembly::get_ghosted_basis_function

(

)

Get a reference to the ghosted_basis_function.

Definition at line 101 of file rb_eim_assembly.C.

{
  return *_ghosted_basis_function;
}

References _ghosted_basis_function.

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

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 69 of file elem_assembly.h.

  {
    // Do nothing by default
  }

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

get_rb_eim_construction()

RBEIMConstruction & libMesh::RBEIMAssembly::get_rb_eim_construction

(

)

Get a reference to the RBEIMConstruction object.

Definition at line 96 of file rb_eim_assembly.C.

{
  return _rb_eim_con;
}

References _rb_eim_con.

Referenced by evaluate_basis_function(), and initialize_fe().

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

initialize_fe()

void libMesh::RBEIMAssembly::initialize_fe ( )

private

Initialize the FE object.

Definition at line 111 of file rb_eim_assembly.C.

{
  DofMap & dof_map = get_rb_eim_construction().get_explicit_system().get_dof_map();
 
  const unsigned int dim =
    get_rb_eim_construction().get_mesh().mesh_dimension();
 
  FEType fe_type = dof_map.variable_type(0);
  _fe = FEBase::build(dim, fe_type);
 
  // Pre-request the shape function for efficieny's sake
  _fe->get_phi();
}

References _fe, libMesh::FEGenericBase< OutputType >::build(), dim, libMesh::System::get_dof_map(), libMesh::RBEIMConstruction::get_explicit_system(), libMesh::System::get_mesh(), get_rb_eim_construction(), libMesh::MeshBase::mesh_dimension(), and libMesh::DofMap::variable_type().

Referenced by RBEIMAssembly().

interior_assembly()

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

inlinevirtualinherited

Perform the element interior assembly.

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

Definition at line 57 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 83 of file reference_counter.h.

  { 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

_basis_function_index

unsigned int libMesh::RBEIMAssembly::_basis_function_index

private

The EIM basis function index (from rb_eim_eval) for this assembly object.

Definition at line 104 of file rb_eim_assembly.h.

Referenced by RBEIMAssembly().

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

_fe

std::unique_ptr<FEBase> libMesh::RBEIMAssembly::_fe

private

We store an FE object so we can easily reinit in evaluate_basis_function.

Definition at line 116 of file rb_eim_assembly.h.

Referenced by get_fe(), and initialize_fe().

_ghosted_basis_function

std::unique_ptr<NumericVector<Number> > libMesh::RBEIMAssembly::_ghosted_basis_function

private

The basis function that we sample to evaluate the empirical interpolation approximation.

This will be a GHOSTED vector to facilitate interpolation in the case of multiple processors.

Definition at line 111 of file rb_eim_assembly.h.

Referenced by get_ghosted_basis_function(), and RBEIMAssembly().

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

_rb_eim_con

RBEIMConstruction& libMesh::RBEIMAssembly::_rb_eim_con

private

The RBEIMConstruction object that this RBEIMAssembly is based on.

Definition at line 99 of file rb_eim_assembly.h.

Referenced by get_rb_eim_construction(), and RBEIMAssembly().

---

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