This class implements ghosting of elements that overlap or touch at at least one sampled point, even if no topological connection between the elements exists. More...

#include <overlap_coupling.h>

Inheritance diagram for libMesh::OverlapCoupling:

[legend]

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?

Public Member Functions
	OverlapCoupling ()
	Constructor.

	OverlapCoupling (const OverlapCoupling &other)
	Copy constructor.

virtual std::unique_ptr< GhostingFunctor >	clone () const override
	A clone() is needed because GhostingFunctor can not be shared between different meshes.

void	set_dof_coupling (const CouplingMatrix *dof_coupling)

void	set_quadrature_rule (std::unique_ptr< QBase > new_q_rule)

virtual void	mesh_reinit () override
	We need an updated point locator to see what other elements might share each quadrature point.

virtual void	redistribute () override
	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.

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

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 the elements which will be coupled to them in the sparsity pattern.

virtual void	set_mesh (const MeshBase *mesh)
	It should be called after cloning a ghosting functor.

virtual void	set_periodic_boundaries (const PeriodicBoundaries *)

const MeshBase *	get_mesh () const
	Return the mesh associated with ghosting functor.

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.

Static Public Member Functions
static std::string	get_info ()
	Gets a string containing the reference information.

static void	print_info (std::ostream &out_stream=libMesh::out)
	Prints the reference information, by default to `libMesh::out`.

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects.

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info().

static void	disable_print_counter_info ()

Public Attributes
return	nullptr { libmesh_deprecated()

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information.

Protected Member Functions
void	increment_constructor_count (const std::string &name) noexcept
	Increments the construction counter.

void	increment_destructor_count (const std::string &name) noexcept
	Increments the destruction counter.

Protected Attributes
const MeshBase *	_mesh

Static Protected Attributes
static Counts	_counts
	Actually holds the data.

static Threads::atomic< unsigned int >	_n_objects
	The number of objects.

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting.

static bool	_enable_print_counter = true
	Flag to control whether reference count information is printed when print_info is called.

Private Attributes
const CouplingMatrix *	_dof_coupling

std::array< std::unique_ptr< QBase >, 3 >	_q_rules

FEMap	_fe_map

Detailed Description

This class implements ghosting of elements that overlap or touch at at least one sampled point, even if no topological connection between the elements exists.

This may be useful for immersed methods, or for integration along both sides of mesh "slits" with no neighbor information.

Author: Roy H. Stogner

Date: 2025

Definition at line 49 of file overlap_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 243 of file ghosting_functor.h.

Constructor & Destructor Documentation

◆ OverlapCoupling() [1/2]

libMesh::OverlapCoupling::OverlapCoupling ( )

Constructor.

Defaults to using a Simpson's Rule quadrature to choose sampling points. Users may wish to attach custom quadrature rules matching those used for their system integration.

Definition at line 35 of file overlap_coupling.C.

                                 :
  _dof_coupling(nullptr)
{
  _q_rules[0] = QBase::build(QSIMPSON, 1, SECOND);
  _q_rules[1] = QBase::build(QSIMPSON, 2, SECOND);
  _q_rules[2] = QBase::build(QSIMPSON, 3, SECOND);
}

References _q_rules, libMesh::QBase::build(), libMesh::QSIMPSON, and libMesh::SECOND.

◆ OverlapCoupling() [2/2]

libMesh::OverlapCoupling::OverlapCoupling ( const OverlapCoupling & other )

Copy constructor.

Definition at line 45 of file overlap_coupling.C.

                                                              :
  GhostingFunctor(other),
  _dof_coupling(other._dof_coupling)
{
  for (auto i : make_range(2))
    if (other._q_rules[i].get())
      _q_rules[i] = other._q_rules[i]->clone();
}

References _q_rules, and libMesh::make_range().

Member Function Documentation

◆ clone()

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

inlineoverridevirtual

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

The operations in GhostingFunctor are mesh dependent.

Implements libMesh::GhostingFunctor.

Definition at line 70 of file overlap_coupling.h.

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

◆ delete_remote_elements()

virtual void libMesh::OverlapCoupling::delete_remote_elements ( )

inlineoverridevirtual

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 from libMesh::GhostingFunctor.

Definition at line 91 of file overlap_coupling.h.

92 { this->mesh_reinit(); }

libMesh::OverlapCoupling::mesh_reinit

virtual void mesh_reinit() override

We need an updated point locator to see what other elements might share each quadrature point.

Definition overlap_coupling.C:66

References mesh_reinit().

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

{
  _enable_print_counter = false;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

◆ 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 274 of file ghosting_functor.h.

274{};

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info().

Enabled by default.

Definition at line 94 of file reference_counter.C.

{
  _enable_print_counter = true;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ 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 & [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
}

References libMesh::ReferenceCounter::_counts.

Referenced by libMesh::ReferenceCounter::print_info().

◆ get_mesh()

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

inlineinherited

Return the mesh associated with ghosting functor.

Definition at line 237 of file ghosting_functor.h.

237{ libmesh_assert(_mesh); return _mesh; }

libMesh::GhostingFunctor::_mesh

const MeshBase * _mesh

Definition ghosting_functor.h:296

libMesh::libmesh_assert

libmesh_assert(ctx)

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

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

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

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), and libMesh::ReferenceCountedObject< T >::ReferenceCountedObject().

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

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

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::~ReferenceCountedObject().

◆ mesh_reinit()

void libMesh::OverlapCoupling::mesh_reinit ( )

overridevirtual

We need an updated point locator to see what other elements might share each quadrature point.

Reimplemented from libMesh::GhostingFunctor.

Definition at line 66 of file overlap_coupling.C.

{
  // We'll need a master point locator, so we'd better have a mesh
  // to build it on.
  libmesh_assert(_mesh);
 
  // Make sure an up-to-date master point locator has been
  // constructed; we'll need to grab sub-locators soon.
  _mesh->sub_point_locator();
}

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

Referenced by delete_remote_elements(), and redistribute().

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

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition reference_counter.h:132

References libMesh::ReferenceCounter::_n_objects.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ operator()()

void libMesh::OverlapCoupling::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 the elements which will be coupled to them in the sparsity pattern.

This will include whatever the point locator finds at each quadrature point in the range.

Implements libMesh::GhostingFunctor.

Definition at line 79 of file overlap_coupling.C.

{
  LOG_SCOPE("operator()", "OverlapCoupling");
 
  std::unique_ptr<PointLocatorBase> point_locator
    = _mesh->sub_point_locator();
 
  const std::vector<Point> & xyz = this->_fe_map.get_xyz();
 
  for (const auto & elem : as_range(range_begin, range_end))
  {
    const unsigned int dim = elem->dim();
 
    QBase & qrule = *_q_rules[dim-1];
    qrule.init(*elem);
 
    _fe_map.init_reference_to_physical_map(dim, qrule.get_points(), elem);
    _fe_map.compute_map(dim, qrule.get_weights(), elem, /*d2phi=*/ false);
 
    std::set<const Elem *> overlapping_elements;
    for (const Point & qp : xyz)
      (*point_locator)(qp, overlapping_elements);
 
    // We should at least find ourselves
    libmesh_assert(overlapping_elements.count(elem));
 
    for (const Elem * e : overlapping_elements)
      if (e->processor_id() != p)
        coupled_elements.emplace(e, _dof_coupling);
  }
}

References libMesh::as_range(), dim, libMesh::QBase::get_points(), libMesh::QBase::get_weights(), libMesh::QBase::init(), and libMesh::libmesh_assert().

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

{
  if (_enable_print_counter)
    out_stream << ReferenceCounter::get_info();
}

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ redistribute()

virtual void libMesh::OverlapCoupling::redistribute ( )

inlineoverridevirtual

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 from libMesh::GhostingFunctor.

Definition at line 88 of file overlap_coupling.h.

89 { this->mesh_reinit(); }

References mesh_reinit().

◆ set_dof_coupling()

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

inline

Definition at line 74 of file overlap_coupling.h.

75 { _dof_coupling = dof_coupling; }

References _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 227 of file ghosting_functor.h.

227{ _mesh = mesh; }

mesh

MeshBase & mesh

Definition mesh_communication.C:1460

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

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

◆ set_periodic_boundaries()

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

inlinevirtualinherited

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

Definition at line 231 of file ghosting_functor.h.

231{}

◆ set_quadrature_rule()

void libMesh::OverlapCoupling::set_quadrature_rule ( std::unique_ptr< QBase > new_q_rule )

Definition at line 56 of file overlap_coupling.C.

{
  libmesh_assert(new_q_rule.get());
  const unsigned int dim = new_q_rule->get_dim();
  _q_rules[dim-1] = std::move(new_q_rule);
}

References _q_rules, dim, and libMesh::libmesh_assert().

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::OverlapCoupling::_dof_coupling

private

Definition at line 108 of file overlap_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().

◆ _fe_map

FEMap libMesh::OverlapCoupling::_fe_map

private

Definition at line 114 of file overlap_coupling.h.

◆ _mesh

const MeshBase* libMesh::GhostingFunctor::_mesh

protectedinherited

Definition at line 296 of file ghosting_functor.h.

Referenced by libMesh::GhostingFunctor::get_mesh(), libMesh::DefaultCoupling::mesh_reinit(), libMesh::NonManifoldGhostingFunctor::mesh_reinit(), 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(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _q_rules

std::array<std::unique_ptr<QBase>, 3> libMesh::OverlapCoupling::_q_rules

private

Definition at line 111 of file overlap_coupling.h.

Referenced by OverlapCoupling(), OverlapCoupling(), and set_quadrature_rule().

◆ nullptr

return libMesh::GhostingFunctor::nullptr { libmesh_deprecated()

inherited

Definition at line 220 of file ghosting_functor.h.

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

include/ghosting/overlap_coupling.h
src/ghosting/overlap_coupling.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Counts

◆ map_type

Constructor & Destructor Documentation

◆ OverlapCoupling() [1/2]

◆ OverlapCoupling() [2/2]

Member Function Documentation

◆ clone()

◆ delete_remote_elements()

◆ disable_print_counter_info()

◆ dofmap_reinit()

◆ enable_print_counter_info()

◆ get_info()

◆ get_mesh()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ mesh_reinit()

◆ n_objects()

◆ operator()()

◆ print_info()

◆ redistribute()

◆ set_dof_coupling()

◆ set_mesh()

◆ set_periodic_boundaries()

◆ set_quadrature_rule()

Member Data Documentation

◆ _counts

◆ _dof_coupling

◆ _enable_print_counter

◆ _fe_map

◆ _mesh

◆ _mutex

◆ _n_objects

◆ _q_rules

◆ nullptr