libMesh::NonManifoldGhostingFunctor Class Reference

A GhostingFunctor subclass that uses a SidesToElemMap object to determine when Elem DOFs should be ghosted in non-manifold meshes. More...

#include <non_manifold_coupling.h>

Inheritance diagram for libMesh::NonManifoldGhostingFunctor:

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
	NonManifoldGhostingFunctor (const MeshBase &mesh)
	Constructor. More...
	NonManifoldGhostingFunctor (const NonManifoldGhostingFunctor &)=default
	Special functions. More...
	NonManifoldGhostingFunctor (NonManifoldGhostingFunctor &&)=default
NonManifoldGhostingFunctor &	operator= (const NonManifoldGhostingFunctor &)=default
NonManifoldGhostingFunctor &	operator= (NonManifoldGhostingFunctor &&)=default
virtual	~NonManifoldGhostingFunctor ()=default
virtual std::unique_ptr< GhostingFunctor >	clone () const override
	clone() just calls the copy ctor. More...
virtual void	mesh_reinit () override
	If the Mesh changes, we'll need to clear the SidesToElemMap and recreate it, since all the neighbor information (standard and non-manifold) might have changed. More...
virtual void	redistribute () override
	When the Mesh is redistributed, we may need to update the information in the SidesToElemMap by removing pointers to non-local Elems. More...
virtual void	delete_remote_elements () override
	When remote elements are deleted, we should remove them from the information in the SidesToElemMap. More...
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, query the SidesToElemMap and add all side neighbors to the list of coupled_elements, ignoring those on processor p. 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	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...

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
MeshTools::SidesToElemMap	_stem
	Quickly-searchable map from (elem, side) pair to list of connected Elems. More...

Detailed Description

A GhostingFunctor subclass that uses a SidesToElemMap object to determine when Elem DOFs should be ghosted in non-manifold meshes.

A basic use case for this functor is "truss" meshes where multiple 1D elements meet at a single node, but there are also 2D generalizations of practical importance, such as "shell stiffener" models where three or more quadrilateral elements meet at the same side. This functor can be used to avoid DOF ghosting issues related to non-manifold meshes which are due to the assumption in libMesh that there is at most one neighbor per Elem side. Notes on the GhostingFunctor-derived classes:

• For the GhostingFunctor::operator() overrides, the input range is saying, "we already need these Elems' DOFs, so what other Elems' DOFs do we need?" This is why we always see the following logic in the GhostingFunctor::operator() overrides:

  if (elem->processor_id() != p) coupled_elements.emplace(elem, _dof_coupling);

• The idea is that the "output" range that we are creating should always include the entire "non-local" part of the input range. We don't need to include members of the input range that are already owned by processor p, see e.g. the API docs which say: "Don't bother to return any results which already have processor_id p."

Author

John W. Peterson

Date

2024

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

NonManifoldGhostingFunctor() [1/3]

libMesh::NonManifoldGhostingFunctor::NonManifoldGhostingFunctor

(

const MeshBase &

mesh

)

Constructor.

Calls base class constructor.

Definition at line 27 of file non_manifold_coupling.C.

                                                  :
  GhostingFunctor(mesh),
  _stem(MeshTools::SidesToElemMap::build(mesh))
{
  // We call MeshBase::reinit_ghosting_functors() in MeshBase::prepare_for_use(),
  // so it _should_ be safe to omit this call to SidesToElemMap::build() here,
  // but to be on the safe side, we'll construct it both here and during any call
  // to mesh_reinit().
}

NonManifoldGhostingFunctor() [2/3]

libMesh::NonManifoldGhostingFunctor::NonManifoldGhostingFunctor ( const NonManifoldGhostingFunctor &  )

default

Special functions.

These are all defaulted for now until there is some reason to delete/customize one of them.

NonManifoldGhostingFunctor() [3/3]

libMesh::NonManifoldGhostingFunctor::NonManifoldGhostingFunctor ( NonManifoldGhostingFunctor &&  )

default

~NonManifoldGhostingFunctor()

virtual libMesh::NonManifoldGhostingFunctor::~NonManifoldGhostingFunctor ( )

virtualdefault

Member Function Documentation

clone()

std::unique_ptr< GhostingFunctor > libMesh::NonManifoldGhostingFunctor::clone ( ) const

overridevirtual

clone() just calls the copy ctor.

Reimplemented from libMesh::GhostingFunctor.

Definition at line 38 of file non_manifold_coupling.C.

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

delete_remote_elements()

void libMesh::NonManifoldGhostingFunctor::delete_remote_elements ( )

overridevirtual

When remote elements are deleted, we should remove them from the information in the SidesToElemMap.

Currently calls mesh_reinit().

Reimplemented from libMesh::GhostingFunctor.

Definition at line 56 of file non_manifold_coupling.C.

References mesh_reinit().

{
  this->mesh_reinit();
}

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

void libMesh::NonManifoldGhostingFunctor::mesh_reinit ( )

overridevirtual

If the Mesh changes, we'll need to clear the SidesToElemMap and recreate it, since all the neighbor information (standard and non-manifold) might have changed.

Reimplemented from libMesh::GhostingFunctor.

Definition at line 44 of file non_manifold_coupling.C.

References libMesh::GhostingFunctor::_mesh, _stem, and libMesh::MeshTools::SidesToElemMap::build().

Referenced by delete_remote_elements(), and redistribute().

{
  _stem = MeshTools::SidesToElemMap::build(*_mesh);
}

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::NonManifoldGhostingFunctor::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, query the SidesToElemMap and add all side neighbors to the list of coupled_elements, ignoring those on processor p.

Implements libMesh::GhostingFunctor.

Definition at line 62 of file non_manifold_coupling.C.

References _stem, libMesh::as_range(), and libMesh::MeshTools::SidesToElemMap::get_connected_elems().

{
  // This code is just for geometric coupling, so we use a null
  // CouplingMatrix pointer.  We'll declare that here so as to avoid
  // confusing the emplace() calls later.
  CouplingMatrix * nullcm = nullptr;

  for (const auto & elem : as_range(range_begin, range_end))
    {
      // The idea here is that the input range [range_begin,
      // range_end] is a list of Elems whose DOFs we already know we
      // want to ghost (if they aren't already owned by processor p,
      // we don't need to worry about ghosting "local" Elem DOFs)
      // Therefore, we always put *all* the non-local Elems in the
      // input range into the output "coupled_elements" map.  The
      // purpose of the rest of this of this function is then to
      // determine which *additional* elements should be ghosted,
      // given that we care about the entire input range.
      if (elem->processor_id() != p)
        coupled_elements.emplace(elem, nullcm);

      // For each side of "elem", look up that (elem, side) pair in
      // the SidesToElemMap and then add all the Elem pointers from
      // that list to the coupled_elements map.
      for (auto s : elem->side_index_range())
        for (const auto & neigh : as_range(_stem.get_connected_elems(elem, s)))
          if (neigh->processor_id() != p)
            coupled_elements.emplace(neigh, nullcm);
    }
}

operator=() [1/2]

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

default

operator=() [2/2]

NonManifoldGhostingFunctor& libMesh::NonManifoldGhostingFunctor::operator= ( NonManifoldGhostingFunctor &&  )

default

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

void libMesh::NonManifoldGhostingFunctor::redistribute ( )

overridevirtual

When the Mesh is redistributed, we may need to update the information in the SidesToElemMap by removing pointers to non-local Elems.

Currently calls mesh_reinit().

Reimplemented from libMesh::GhostingFunctor.

Definition at line 50 of file non_manifold_coupling.C.

References mesh_reinit().

{
  this->mesh_reinit();
}

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

_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::OverlapCoupling::mesh_reinit(), mesh_reinit(), 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().

_stem

MeshTools::SidesToElemMap libMesh::NonManifoldGhostingFunctor::_stem

private

Quickly-searchable map from (elem, side) pair to list of connected Elems.

Definition at line 121 of file non_manifold_coupling.h.

Referenced by mesh_reinit(), and operator()().

---

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

• include/ghosting/non_manifold_coupling.h
• src/ghosting/non_manifold_coupling.C