Inheritance diagram for OverlappingCouplingFunctor:

[legend]

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

Public Member Functions
	OverlappingCouplingFunctor (System &system)

virtual	~OverlappingCouplingFunctor ()

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, std::unordered_map< const Elem , const CouplingMatrix > &coupled_elements) override

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)=0
	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. 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=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)
	Increments the construction counter. More...

void	increment_destructor_count (const std::string &name)
	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...

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 117 of file reference_counter.h.

◆ map_type

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

inherited

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

Definition at line 171 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, (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();
   }

◆ ~OverlappingCouplingFunctor()

virtual OverlappingCouplingFunctor::~OverlappingCouplingFunctor ( )

inlinevirtual

Definition at line 61 of file overlapping_coupling_test.C.

61 {};

Member Function Documentation

◆ 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, and libMesh::DefaultCoupling.

Definition at line 221 of file ghosting_functor.h.

221 {};

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

 {
   _enable_print_counter = false;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

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

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

202 {};

◆ 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 100 of file reference_counter.C.

 {
   _enable_print_counter = true;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

◆ 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 & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
  
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
  
   oss << " ---------------------------------------------------------------------------- \n";
  
   return oss.str();
  
 #else
  
   return "";
  
 #endif
 }

References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().

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

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

inlineprotectedinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
  
   p.first++;
 }

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

inlineprotectedinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
  
   p.second++;
 }

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~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 AugmentSparsityOnNodes, libMesh::PointNeighborCoupling, libMesh::DefaultCoupling, and AugmentSparsityOnInterface.

Definition at line 194 of file ghosting_functor.h.

194 {};

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

84 { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

◆ operator()() [1/2]

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

pure virtualinherited

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.

Implemented in libMesh::DefaultCoupling, libMesh::PointNeighborCoupling, AugmentSparsityOnNodes, libMesh::SiblingCoupling, and libMesh::GhostPointNeighbors.

◆ operator()() [2/2]

virtual void OverlappingCouplingFunctor::operator()	(	const MeshBase::const_element_iterator &	range_begin,
		const MeshBase::const_element_iterator &	range_end,
		processor_id_type	p,
		std::unordered_map< const Elem , const CouplingMatrix > &	coupled_elements
	)

inlineoverridevirtual

Definition at line 67 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.insert( std::make_pair(overlapping_elem,_coupling_matrix.get()) );
           }
       }
   }

References libMesh::as_range(), libMesh::FEGenericBase< OutputType >::build(), libMesh::FEType::default_quadrature_order(), dim, and libMesh::DofObject::processor_id().

◆ print_info()

void libMesh::ReferenceCounter::print_info ( std::ostream & out = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 87 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().

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

214 {};

◆ set_coupling_matrix()

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

inline

Definition at line 63 of file overlapping_coupling_test.C.

64 { _coupling_matrix = std::move(coupling_matrix); }

Member Data Documentation

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _coupling_matrix

std::unique_ptr<CouplingMatrix> OverlappingCouplingFunctor::_coupling_matrix

private

Definition at line 119 of file overlapping_coupling_test.C.

◆ _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 141 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& OverlappingCouplingFunctor::_mesh

private

Definition at line 115 of file overlapping_coupling_test.C.

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 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 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _point_locator

std::unique_ptr<PointLocatorBase> OverlappingCouplingFunctor::_point_locator

private

Definition at line 117 of file overlapping_coupling_test.C.

◆ _system

System& OverlappingCouplingFunctor::_system

private

Definition at line 113 of file overlapping_coupling_test.C.

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

tests/base/overlapping_coupling_test.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Counts

◆ map_type

Constructor & Destructor Documentation

◆ OverlappingCouplingFunctor()

◆ ~OverlappingCouplingFunctor()

Member Function Documentation

◆ delete_remote_elements()

◆ disable_print_counter_info()

◆ dofmap_reinit()

◆ enable_print_counter_info()

◆ get_info()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ mesh_reinit()

◆ n_objects()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ print_info()

◆ redistribute()

◆ set_coupling_matrix()

Member Data Documentation

◆ _counts

◆ _coupling_matrix

◆ _enable_print_counter

◆ _mesh

◆ _mutex

◆ _n_objects

◆ _point_locator

◆ _system