libMesh
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Attributes | Private Attributes | List of all members
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:
[legend]

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
 
RBEIMAssemblyoperator= (const RBEIMAssembly &)=delete
 
RBEIMAssemblyoperator= (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...
 
RBEIMConstructionget_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.

36  :
37  _rb_eim_con(rb_eim_con),
38  _basis_function_index(basis_function_index_in)
39 {
40 }
unsigned int _basis_function_index
The EIM basis function index (from _rb_eim_con&#39;s RBEIMEvaluation) for this assembly object...
RBEIMConstruction & _rb_eim_con
The RBEIMConstruction that the assembly data comes from.

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

60 { }

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

101 {
102  _enable_print_counter = false;
103  return;
104 }
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...

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

95 {
96  _enable_print_counter = true;
97  return;
98 }
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...

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

47 {
49  _basis_function_index, elem_id, comp, values);
50 
51  libmesh_error_msg_if(values.empty(), "Error: EIM basis function has no entries on this element for this processor");
52 }
RBEIMEvaluation & get_rb_eim_evaluation()
Get a reference to the RBEvaluation object.
void get_eim_basis_function_values_at_qps(unsigned int basis_function_index, dof_id_type elem_id, unsigned int var, std::vector< Number > &values) const
Fill up values with the basis function values for basis function basis_function_index and variable va...
RBEIMConstruction & get_rb_eim_construction()
Get a reference to the RBEIMEvaluation object.
unsigned int _basis_function_index
The EIM basis function index (from _rb_eim_con&#39;s RBEIMEvaluation) for this assembly object...

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

67 {
69  _basis_function_index, node_id, comp);
70 }
RBEIMEvaluation & get_rb_eim_evaluation()
Get a reference to the RBEvaluation object.
Number get_eim_basis_function_node_local_value(unsigned int basis_function_index, dof_id_type node_id, unsigned int var) const
Same as get_eim_basis_function_values_at_qps() except for node data.
RBEIMConstruction & get_rb_eim_construction()
Get a reference to the RBEIMEvaluation object.
unsigned int _basis_function_index
The EIM basis function index (from _rb_eim_con&#39;s RBEIMEvaluation) for this assembly object...

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

58 {
60  _basis_function_index, elem_id, side_index, comp, values);
61 
62  libmesh_error_msg_if(values.empty(), "Error: EIM basis function has no entries on this element for this processor");
63 }
void get_eim_basis_function_side_values_at_qps(unsigned int basis_function_index, dof_id_type elem_id, unsigned int side_index, unsigned int var, std::vector< Number > &values) const
Same as get_eim_basis_function_values_at_qps() except for side data.
RBEIMEvaluation & get_rb_eim_evaluation()
Get a reference to the RBEvaluation object.
RBEIMConstruction & get_rb_eim_construction()
Get a reference to the RBEIMEvaluation object.
unsigned int _basis_function_index
The EIM basis function index (from _rb_eim_con&#39;s RBEIMEvaluation) for this assembly object...

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

48 {
49 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
50 
51  std::ostringstream oss;
52 
53  oss << '\n'
54  << " ---------------------------------------------------------------------------- \n"
55  << "| Reference count information |\n"
56  << " ---------------------------------------------------------------------------- \n";
57 
58  for (const auto & [name, cd] : _counts)
59  oss << "| " << name << " reference count information:\n"
60  << "| Creations: " << cd.first << '\n'
61  << "| Destructions: " << cd.second << '\n';
62 
63  oss << " ---------------------------------------------------------------------------- \n";
64 
65  return oss.str();
66 
67 #else
68 
69  return "";
70 
71 #endif
72 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:42
static Counts _counts
Actually holds the data.

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

72  {
73  // Do nothing by default
74  }

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

73 {
74  return _rb_eim_con;
75 }
RBEIMConstruction & _rb_eim_con
The RBEIMConstruction that the assembly data comes from.

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

184 {
185  libmesh_try
186  {
187  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
188  std::pair<unsigned int, unsigned int> & p = _counts[name];
189  p.first++;
190  }
191  libmesh_catch (...)
192  {
193  auto stream = libMesh::err.get();
194  stream->exceptions(stream->goodbit); // stream must not throw
195  libMesh::err << "Encountered unrecoverable error while calling "
196  << "ReferenceCounter::increment_constructor_count() "
197  << "for a(n) " << name << " object." << std::endl;
198  std::terminate();
199  }
200 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:42
OStreamProxy err
static Counts _counts
Actually holds the data.
streamT * get()
Rather than implement every ostream/ios/ios_base function, we&#39;ll be lazy and make esoteric uses go th...
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition: threads.C:30

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

208 {
209  libmesh_try
210  {
211  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
212  std::pair<unsigned int, unsigned int> & p = _counts[name];
213  p.second++;
214  }
215  libmesh_catch (...)
216  {
217  auto stream = libMesh::err.get();
218  stream->exceptions(stream->goodbit); // stream must not throw
219  libMesh::err << "Encountered unrecoverable error while calling "
220  << "ReferenceCounter::increment_destructor_count() "
221  << "for a(n) " << name << " object." << std::endl;
222  std::terminate();
223  }
224 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:42
OStreamProxy err
static Counts _counts
Actually holds the data.
streamT * get()
Rather than implement every ostream/ios/ios_base function, we&#39;ll be lazy and make esoteric uses go th...
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition: threads.C:30

◆ interior_assembly()

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

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

86  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of 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().

82 {
84  out_stream << ReferenceCounter::get_info();
85 }
static std::string get_info()
Gets a string containing the reference information.
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...

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: