OutputAssembly Struct Reference

Output assembly object which computes the average value of the solution variable inside a user-provided BoundingBox. More...

#include <assembly.h>

Inheritance diagram for OutputAssembly:

Public Member Functions
	OutputAssembly (Real min_x_in, Real max_x_in, Real min_y_in, Real max_y_in)
virtual void	interior_assembly (FEMContext &c)
	Perform the element interior assembly. More...
	OutputAssembly (Real min_x_in, Real max_x_in, Real min_y_in, Real max_y_in)
virtual void	interior_assembly (FEMContext &c)
	Perform the element interior assembly. More...
	OutputAssembly (Real min_x_in, Real max_x_in, Real min_y_in, Real max_y_in)
virtual void	interior_assembly (FEMContext &c)
	Perform the element interior assembly. More...
	OutputAssembly (const BoundingBox &bbox_in)
virtual void	interior_assembly (FEMContext &c)
	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 ()

Public Attributes
Real	min_x
Real	max_x
Real	min_y
Real	max_y
BoundingBox	bbox

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

Output assembly object which computes the average value of the solution variable inside a user-provided BoundingBox.

OutputAssembly is also used in reduced_basis_ex1.

Definition at line 153 of file 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

OutputAssembly() [1/4]

OutputAssembly::OutputAssembly ( Real  min_x_in, Real  max_x_in, Real  min_y_in, Real  max_y_in  )

inline

Definition at line 155 of file assembly.h.

    :
    min_x(min_x_in),
    max_x(max_x_in),
    min_y(min_y_in),
    max_y(max_y_in)
  {}

OutputAssembly() [2/4]

OutputAssembly::OutputAssembly ( Real  min_x_in, Real  max_x_in, Real  min_y_in, Real  max_y_in  )

inline

Definition at line 199 of file assembly.h.

                                               :
    min_x(min_x_in),
    max_x(max_x_in),
    min_y(min_y_in),
    max_y(max_y_in)
  {}

OutputAssembly() [3/4]

OutputAssembly::OutputAssembly ( Real  min_x_in, Real  max_x_in, Real  min_y_in, Real  max_y_in  )

inline

Definition at line 183 of file assembly.h.

    :
    min_x(min_x_in),
    max_x(max_x_in),
    min_y(min_y_in),
    max_y(max_y_in)
  {}

OutputAssembly() [4/4]

OutputAssembly::OutputAssembly ( const BoundingBox &  bbox_in )

inline

Definition at line 237 of file assembly.h.

                                              :
    bbox(bbox_in)
  {}

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

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
  }

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() [1/4]

virtual void OutputAssembly::interior_assembly ( FEMContext &  )

inlinevirtual

Perform the element interior assembly.

Reimplemented from libMesh::ElemAssembly.

Definition at line 165 of file assembly.h.

References libMesh::DiffContext::get_dof_indices(), libMesh::FEMContext::get_elem(), libMesh::DiffContext::get_elem_residual(), libMesh::FEMContext::get_element_fe(), libMesh::FEMContext::get_element_qrule(), max_x, max_y, min_x, min_y, libMesh::QBase::n_points(), libMesh::Real, and libMesh::Elem::vertex_average().

  {
    const unsigned int u_var = 0;

    FEBase * elem_fe = nullptr;
    c.get_element_fe(u_var, elem_fe);

    const std::vector<Real> & JxW = elem_fe->get_JxW();

    const std::vector<std::vector<Real>> & phi = elem_fe->get_phi();

    // The number of local degrees of freedom in each variable
    const unsigned int n_u_dofs = c.get_dof_indices(u_var).size();

    // Now we will build the affine operator
    unsigned int n_qpoints = c.get_element_qrule().n_points();

    Real output_area = (max_x-min_x) * (max_y-min_y);

    Point avg = c.get_elem().vertex_average();
    if ((min_x <= avg(0)) && (avg(0) <= max_x) &&
        (min_y <= avg(1)) && (avg(1) <= max_y))
      for (unsigned int qp=0; qp != n_qpoints; qp++)
        for (unsigned int i=0; i != n_u_dofs; i++)
          c.get_elem_residual()(i) += JxW[qp] * (1.*phi[i][qp]) / output_area;
  }

interior_assembly() [2/4]

virtual void OutputAssembly::interior_assembly ( FEMContext &  )

inlinevirtual

Perform the element interior assembly.

Reimplemented from libMesh::ElemAssembly.

Definition at line 193 of file assembly.h.

References libMesh::DiffContext::get_dof_indices(), libMesh::FEMContext::get_elem(), libMesh::DiffContext::get_elem_residual(), libMesh::FEMContext::get_element_fe(), libMesh::FEMContext::get_element_qrule(), max_x, max_y, min_x, min_y, libMesh::QBase::n_points(), libMesh::Real, and libMesh::Elem::vertex_average().

  {
    const unsigned int u_var = 0;

    FEBase * elem_fe = nullptr;
    c.get_element_fe(u_var, elem_fe);

    const std::vector<Real> & JxW = elem_fe->get_JxW();

    const std::vector<std::vector<Real>> & phi = elem_fe->get_phi();

    // The number of local degrees of freedom in each variable
    const unsigned int n_u_dofs = c.get_dof_indices(u_var).size();

    // Now we will build the affine operator
    unsigned int n_qpoints = c.get_element_qrule().n_points();

    Real output_area = (max_x-min_x) * (max_y-min_y);

    Point avg = c.get_elem().vertex_average();
    if ((min_x <= avg(0)) && (avg(0) <= max_x) &&
        (min_y <= avg(1)) && (avg(1) <= max_y))
      for (unsigned int qp=0; qp != n_qpoints; qp++)
        for (unsigned int i=0; i != n_u_dofs; i++)
          c.get_elem_residual()(i) += JxW[qp] * (1.*phi[i][qp]) / output_area;
  }

interior_assembly() [3/4]

virtual void OutputAssembly::interior_assembly ( FEMContext &  )

inlinevirtual

Perform the element interior assembly.

Reimplemented from libMesh::ElemAssembly.

Definition at line 208 of file assembly.h.

References libMesh::DiffContext::get_dof_indices(), libMesh::FEMContext::get_elem(), libMesh::DiffContext::get_elem_residual(), libMesh::FEMContext::get_element_fe(), libMesh::FEMContext::get_element_qrule(), max_x, max_y, min_x, min_y, libMesh::QBase::n_points(), libMesh::Real, and libMesh::Elem::vertex_average().

  {
    const unsigned int u_var = 0;

    FEBase * elem_fe = nullptr;
    c.get_element_fe(u_var, elem_fe);

    const std::vector<Real> & JxW = elem_fe->get_JxW();

    const std::vector<std::vector<Real>> & phi = elem_fe->get_phi();

    // The number of local degrees of freedom in each variable
    const unsigned int n_u_dofs = c.get_dof_indices(u_var).size();

    // Now we will build the affine operator
    unsigned int n_qpoints = c.get_element_qrule().n_points();

    Real output_area = (max_x-min_x) * (max_y-min_y);

    Point avg = c.get_elem().vertex_average();
    if ((min_x <= avg(0)) && (avg(0) <= max_x) &&
        (min_y <= avg(1)) && (avg(1) <= max_y))
      for (unsigned int qp=0; qp != n_qpoints; qp++)
        for (unsigned int i=0; i != n_u_dofs; i++)
          c.get_elem_residual()(i) += JxW[qp] * (1.*phi[i][qp]) / output_area;
  }

interior_assembly() [4/4]

virtual void OutputAssembly::interior_assembly ( FEMContext &  )

inlinevirtual

Perform the element interior assembly.

Reimplemented from libMesh::ElemAssembly.

Definition at line 242 of file assembly.h.

References bbox, libMesh::BoundingBox::contains_point(), libMesh::DiffContext::get_dof_indices(), libMesh::FEMContext::get_elem(), libMesh::DiffContext::get_elem_residual(), libMesh::FEMContext::get_element_fe(), libMesh::FEMContext::get_element_qrule(), libMesh::BoundingBox::max(), libMesh::BoundingBox::min(), libMesh::QBase::n_points(), libMesh::Real, and libMesh::Elem::vertex_average().

  {
    const unsigned int u_var = 0;

    FEBase * fe = nullptr;
    c.get_element_fe(u_var, fe);

    const std::vector<Real> & JxW = fe->get_JxW();
    const std::vector<std::vector<Real>> & phi = fe->get_phi();

    // The number of local degrees of freedom in each variable
    const unsigned int n_u_dofs = c.get_dof_indices(u_var).size();

    // Now we will build the affine operator
    unsigned int n_qpoints = c.get_element_qrule().n_points();

    // TODO: BoundingBox should be able to compute and return its area/volume
    Real output_area = (bbox.max()(0) - bbox.min()(0)) * (bbox.max()(1) - bbox.min()(1));

    if (bbox.contains_point(c.get_elem().vertex_average()))
      for (unsigned int qp=0; qp != n_qpoints; qp++)
        for (unsigned int i=0; i != n_u_dofs; i++)
          c.get_elem_residual()(i) += JxW[qp] * phi[i][qp] / output_area;
  }

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

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

bbox

BoundingBox OutputAssembly::bbox

Definition at line 268 of file assembly.h.

Referenced by interior_assembly().

max_x

Real OutputAssembly::max_x

Definition at line 193 of file assembly.h.

Referenced by interior_assembly().

max_y

Real OutputAssembly::max_y

Definition at line 193 of file assembly.h.

Referenced by interior_assembly().

min_x

Real OutputAssembly::min_x

Definition at line 193 of file assembly.h.

Referenced by interior_assembly().

min_y

Real OutputAssembly::min_y

Definition at line 193 of file assembly.h.

Referenced by interior_assembly().

---

The documentation for this struct was generated from the following file:

• examples/reduced_basis/reduced_basis_ex1/assembly.h