libMesh::SiblingCoupling Class Reference

This class adds coupling (for use in send_list construction) between active elements and all descendants of their parent. More...

#include <sibling_coupling.h>

Inheritance diagram for libMesh::SiblingCoupling:

Public Types
typedef std::map< const Elem *, const CouplingMatrix *, CompareDofObjectsByPIDAndThenID >	map_type
	What elements do we care about and what variables do we care about on each element? More...

Public Member Functions
	SiblingCoupling ()
	Constructor. More...
	SiblingCoupling (const SiblingCoupling &other)
	Constructor. More...
void	set_dof_coupling (const CouplingMatrix *dof_coupling)
virtual void	operator() (const MeshBase::const_element_iterator &range_begin, const MeshBase::const_element_iterator &range_end, processor_id_type p, map_type &coupled_elements) override
	For the specified range of active elements, find any sibling elements which should be evaluable too. More...
virtual std::unique_ptr< GhostingFunctor >	clone () const override
	A clone() is needed because GhostingFunctor can not be shared between different meshes. More...
virtual void	set_mesh (const MeshBase *mesh)
	It should be called after cloning a ghosting functor. More...
virtual void	set_periodic_boundaries (const PeriodicBoundaries *)
const MeshBase *	get_mesh () const
	Return the mesh associated with ghosting functor. More...
virtual void	mesh_reinit ()
	GhostingFunctor subclasses which cache data will need to initialize that cache. More...
virtual void	dofmap_reinit ()
	For algebraic ghosting or coupling functors we also call dofmap_reinit() later, after dofs have been distributed on the new mesh but before the functors have been queried for send_list or sparsity pattern calculations. More...
virtual void	redistribute ()
	GhostingFunctor subclasses with relatively long-lasting caches may want to redistribute those caches whenever the relevant Mesh is redistributed; we will give them an opportunity when that happens. More...
virtual void	delete_remote_elements ()
	GhostingFunctor subclasses with relatively long-lasting caches may want to delete the no-longer-relevant parts of those caches after a redistribution is complete. 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...

Protected Attributes
const MeshBase *	_mesh

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
const CouplingMatrix *	_dof_coupling

Detailed Description

This class adds coupling (for use in send_list construction) between active elements and all descendants of their parent.

This may be useful when constructing projections onto the parent element for error indicator evaluation.

Author

Roy H. Stogner

Date

2016

Definition at line 42 of file sibling_coupling.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.

map_type

typedef std::map<const Elem*, const CouplingMatrix*, CompareDofObjectsByPIDAndThenID> libMesh::GhostingFunctor::map_type

inherited

What elements do we care about and what variables do we care about on each element?

Definition at line 241 of file ghosting_functor.h.

Constructor & Destructor Documentation

SiblingCoupling() [1/2]

libMesh::SiblingCoupling::SiblingCoupling ( )

inline

Constructor.

Definition at line 49 of file sibling_coupling.h.

                    :
    _dof_coupling(nullptr) {}

SiblingCoupling() [2/2]

libMesh::SiblingCoupling::SiblingCoupling ( const SiblingCoupling &  other )

inline

Constructor.

Definition at line 55 of file sibling_coupling.h.

                                                 : GhostingFunctor(other),
    _dof_coupling(other._dof_coupling) {}

Member Function Documentation

clone()

virtual std::unique_ptr<GhostingFunctor> libMesh::SiblingCoupling::clone ( ) const

inlineoverridevirtual

A clone() is needed because GhostingFunctor can not be shared between different meshes.

The operations in GhostingFunctor are mesh dependent.

Reimplemented from libMesh::GhostingFunctor.

Definition at line 75 of file sibling_coupling.h.

   { return std::make_unique<SiblingCoupling>(*this); }

delete_remote_elements()

virtual void libMesh::GhostingFunctor::delete_remote_elements ( )

inlinevirtualinherited

GhostingFunctor subclasses with relatively long-lasting caches may want to delete the no-longer-relevant parts of those caches after a redistribution is complete.

Reimplemented in libMesh::PointNeighborCoupling, libMesh::DefaultCoupling, and libMesh::GhostPointNeighbors.

Definition at line 291 of file ghosting_functor.h.

{};

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

dofmap_reinit()

virtual void libMesh::GhostingFunctor::dofmap_reinit ( )

inlinevirtualinherited

For algebraic ghosting or coupling functors we also call dofmap_reinit() later, after dofs have been distributed on the new mesh but before the functors have been queried for send_list or sparsity pattern calculations.

Definition at line 272 of file ghosting_functor.h.

{};

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

const MeshBase* libMesh::GhostingFunctor::get_mesh ( ) const

inlineinherited

Return the mesh associated with ghosting functor.

Definition at line 235 of file ghosting_functor.h.

References libMesh::GhostingFunctor::_mesh, and libMesh::libmesh_assert().

{ libmesh_assert(_mesh); return _mesh; }

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

mesh_reinit()

virtual void libMesh::GhostingFunctor::mesh_reinit ( )

inlinevirtualinherited

GhostingFunctor subclasses which cache data will need to initialize that cache.

We call mesh_reinit() whenever the relevant Mesh has changed, but before remote elements on a distributed mesh are deleted.

Reimplemented in AugmentSparsityOnNodes, libMesh::PointNeighborCoupling, libMesh::DefaultCoupling, and AugmentSparsityOnInterface.

Definition at line 264 of file ghosting_functor.h.

Referenced by libMesh::GhostPointNeighbors::delete_remote_elements().

{};

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

void libMesh::SiblingCoupling::operator() ( const MeshBase::const_element_iterator &  range_begin, const MeshBase::const_element_iterator &  range_end, processor_id_type  p, map_type &  coupled_elements  )

overridevirtual

For the specified range of active elements, find any sibling elements which should be evaluable too.

Implements libMesh::GhostingFunctor.

Definition at line 30 of file sibling_coupling.C.

References libMesh::Elem::active_family_tree(), libMesh::as_range(), libMesh::libmesh_assert(), and libMesh::Elem::parent().

{
  LOG_SCOPE("operator()", "SiblingCoupling");

  libmesh_assert(_mesh);

  for (const auto & elem : as_range(range_begin, range_end))
    {
      std::vector<const Elem *> active_siblings;

      libmesh_assert(_mesh->query_elem_ptr(elem->id()) == elem);

      const Elem * parent = elem->parent();
      if (!parent)
        continue;

#ifdef LIBMESH_ENABLE_AMR
      parent->active_family_tree(active_siblings);
#endif

      for (const Elem * sibling : active_siblings)
        if (sibling->processor_id() != p)
          coupled_elements.emplace(sibling, _dof_coupling);
    }
}

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

redistribute()

virtual void libMesh::GhostingFunctor::redistribute ( )

inlinevirtualinherited

GhostingFunctor subclasses with relatively long-lasting caches may want to redistribute those caches whenever the relevant Mesh is redistributed; we will give them an opportunity when that happens.

At the point in the code where this is called, element processor ids have been set to their new destinations, and those elements have been copied to their new destinations, but the elements have not yet been deleted by the processors which previously held them..

Reimplemented in AugmentSparsityOnNodes, libMesh::PointNeighborCoupling, libMesh::DefaultCoupling, and AugmentSparsityOnInterface.

Definition at line 284 of file ghosting_functor.h.

{};

set_dof_coupling()

void libMesh::SiblingCoupling::set_dof_coupling ( const CouplingMatrix *  dof_coupling )

inline

Definition at line 59 of file sibling_coupling.h.

References _dof_coupling.

  { _dof_coupling = dof_coupling; }

set_mesh()

virtual void libMesh::GhostingFunctor::set_mesh ( const MeshBase *  mesh )

inlinevirtualinherited

It should be called after cloning a ghosting functor.

Ghosting functor is mesh dependent

Definition at line 225 of file ghosting_functor.h.

References libMesh::GhostingFunctor::_mesh, and mesh.

Referenced by libMesh::DofMap::add_algebraic_ghosting_functor(), and libMesh::DofMap::add_coupling_functor().

{ _mesh = mesh; }

set_periodic_boundaries()

virtual void libMesh::GhostingFunctor::set_periodic_boundaries ( const PeriodicBoundaries *  )

inlinevirtualinherited

Reimplemented in libMesh::PointNeighborCoupling, and libMesh::DefaultCoupling.

Definition at line 229 of file ghosting_functor.h.

{}

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

_dof_coupling

const CouplingMatrix* libMesh::SiblingCoupling::_dof_coupling

private

Definition at line 80 of file sibling_coupling.h.

Referenced by set_dof_coupling().

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

_mesh

const MeshBase* libMesh::GhostingFunctor::_mesh

protectedinherited

Definition at line 291 of file ghosting_functor.h.

Referenced by libMesh::GhostingFunctor::get_mesh(), libMesh::DefaultCoupling::mesh_reinit(), libMesh::PointNeighborCoupling::mesh_reinit(), and libMesh::GhostingFunctor::set_mesh().

_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/ghosting/sibling_coupling.h
• src/ghosting/sibling_coupling.C