Inheritance diagram for OverlappingCouplingFunctor:

[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
	OverlappingCouplingFunctor (System &system)

virtual	~OverlappingCouplingFunctor ()

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

void	set_coupling_matrix (std::unique_ptr< CouplingMatrix > &coupling_matrix)

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, what other elements currently living (whether local or ghosted) on this processor need to be coupled/ghosted to accommodate them? Don't bother to return any results which already have processor_id p.

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	mesh_reinit ()
	GhostingFunctor subclasses which cache data will need to initialize that cache.

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.

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.

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.

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.

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
System &	_system

const MeshBase &	_mesh

std::unique_ptr< PointLocatorBase >	_point_locator

std::unique_ptr< CouplingMatrix >	_coupling_matrix

Detailed Description

Definition at line 37 of file overlapping_coupling_test.C.

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

◆ OverlappingCouplingFunctor()

OverlappingCouplingFunctor::OverlappingCouplingFunctor ( System & system )

inline

Definition at line 41 of file overlapping_coupling_test.C.

    : GhostingFunctor(),
      _system(system),
      _mesh(system.get_mesh()),
      _point_locator(system.get_mesh().sub_point_locator()),
      _coupling_matrix(nullptr)
  {
    // This is a highly specalized coupling functor where we are assuming
    // only two subdomains that are overlapping so make sure there's only two.
    CPPUNIT_ASSERT_EQUAL(2, static_cast<int>(_mesh.n_subdomains()));
 
    // We're assuming a specific set of subdomain ids
    std::set<subdomain_id_type> ids;
    _mesh.subdomain_ids(ids);
    CPPUNIT_ASSERT( ids.find(1) != ids.end() );
    CPPUNIT_ASSERT( ids.find(2) != ids.end() );
 
    _point_locator->enable_out_of_mesh_mode();
  }

References _mesh, _point_locator, libMesh::MeshBase::n_subdomains(), and libMesh::MeshBase::subdomain_ids().

◆ ~OverlappingCouplingFunctor()

virtual OverlappingCouplingFunctor::~OverlappingCouplingFunctor ( )

inlinevirtual

Definition at line 61 of file overlapping_coupling_test.C.

61{};

Member Function Documentation

◆ clone()

virtual std::unique_ptr< GhostingFunctor > OverlappingCouplingFunctor::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 63 of file overlapping_coupling_test.C.

  {
    auto clone_functor =
      std::make_unique<OverlappingCouplingFunctor>(_system);
 
    auto coupling_matrix =
      std::make_unique<CouplingMatrix>(*_coupling_matrix);
    clone_functor->set_coupling_matrix(coupling_matrix);
    return clone_functor;
  }

References _coupling_matrix, and _system.

◆ 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::DefaultCoupling, libMesh::GhostPointNeighbors, libMesh::NonManifoldGhostingFunctor, libMesh::OverlapCoupling, and libMesh::PointNeighborCoupling.

Definition at line 293 of file ghosting_functor.h.

293{};

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

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 AugmentSparsityOnInterface, libMesh::DefaultCoupling, libMesh::NonManifoldGhostingFunctor, libMesh::OverlapCoupling, libMesh::PointNeighborCoupling, and AugmentSparsityOnNodes.

Definition at line 266 of file ghosting_functor.h.

266{};

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.

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

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

inlineoverridevirtual

For the specified range of active elements, what other elements currently living (whether local or ghosted) on this processor need to be coupled/ghosted to accommodate them? Don't bother to return any results which already have processor_id p.

This API is new, and we should replace "ignoring those on processor p" with "ignoring those which match a predicate functor" eventually.

Implements libMesh::GhostingFunctor.

Definition at line 77 of file overlapping_coupling_test.C.

  {
    std::unique_ptr<PointLocatorBase> sub_point_locator = _mesh.sub_point_locator();
 
    for( const auto & elem : as_range(range_begin,range_end) )
      {
        std::set<subdomain_id_type> allowed_subdomains;
        unsigned int var = 0;
        if( elem->subdomain_id() == 1 )
          {
            var = _system.variable_number("V");
            allowed_subdomains.insert(2);
          }
        else if( elem->subdomain_id() == 2 )
          {
            var = _system.variable_number("U");
            allowed_subdomains.insert(1);
          }
        else
          CPPUNIT_FAIL("Something bad happpend");
 
        unsigned int dim = 2;
        FEType fe_type = _system.variable_type(var);
        std::unique_ptr<FEBase> fe (FEBase::build(dim, fe_type));
        QGauss qrule (dim, fe_type.default_quadrature_order());
        fe->attach_quadrature_rule (&qrule);
 
        const std::vector<libMesh::Point> & qpoints = fe->get_xyz();
 
        fe->reinit(elem);
 
        for ( const auto & qp : qpoints )
          {
            const Elem * overlapping_elem = (*sub_point_locator)( qp, &allowed_subdomains );
 
            if( overlapping_elem && overlapping_elem->processor_id() != p )
              coupled_elements.emplace(overlapping_elem, _coupling_matrix.get());
          }
      }
  }

References _coupling_matrix, _mesh, _system, libMesh::as_range(), libMesh::FEGenericBase< OutputType >::build(), libMesh::FEType::default_quadrature_order(), dim, libMesh::DofObject::processor_id(), libMesh::MeshBase::sub_point_locator(), libMesh::System::variable_number(), and libMesh::System::variable_type().

◆ 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::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 AugmentSparsityOnInterface, libMesh::DefaultCoupling, libMesh::NonManifoldGhostingFunctor, libMesh::OverlapCoupling, libMesh::PointNeighborCoupling, and AugmentSparsityOnNodes.

Definition at line 286 of file ghosting_functor.h.

286{};