#include <default_coupling.h>

Inheritance diagram for libMesh::DefaultCoupling:

Public Types
typedef std::unordered_map< const Elem , const CouplingMatrix >	map_type

Public Member Functions
	DefaultCoupling ()

void	set_dof_coupling (const CouplingMatrix *dof_coupling)

unsigned int	n_levels ()

void	set_n_levels (unsigned int n_levels)

void	set_periodic_boundaries (const PeriodicBoundaries *periodic_bcs)

void	set_mesh (const MeshBase *mesh)

virtual void	mesh_reinit () override

virtual void	redistribute () override

virtual void	delete_remote_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) override

virtual void	dofmap_reinit ()

Static Public Member Functions
static std::string	get_info ()

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

static unsigned int	n_objects ()

static void	enable_print_counter_info ()

static void	disable_print_counter_info ()

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts

Protected Member Functions
void	increment_constructor_count (const std::string &name)

void	increment_destructor_count (const std::string &name)

Static Protected Attributes
static Counts	_counts

static Threads::atomic< unsigned int >	_n_objects

static Threads::spin_mutex	_mutex

static bool	_enable_print_counter = true

Private Attributes
const CouplingMatrix *	_dof_coupling

const PeriodicBoundaries *	_periodic_bcs

const MeshBase *	_mesh

unsigned int	_n_levels

Detailed Description

This class implements the default algebraic coupling in libMesh: elements couple to themselves, but may also couple to neighbors both locally and across periodic boundary conditions.

Author: Roy H. Stogner

Date: 2016

Definition at line 41 of file default_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 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 154 of file ghosting_functor.h.

Constructor & Destructor Documentation

◆ DefaultCoupling()

libMesh::DefaultCoupling::DefaultCoupling ( )

inline

Constructor.

Definition at line 48 of file default_coupling.h.

                     :
     _dof_coupling(nullptr),
 #ifdef LIBMESH_ENABLE_PERIODIC
     _periodic_bcs(nullptr),
 #endif
     _mesh(nullptr),
     _n_levels(0)
   {}

Member Function Documentation

◆ delete_remote_elements()

virtual void libMesh::DefaultCoupling::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 87 of file default_coupling.h.

References mesh_reinit().

88 { this->mesh_reinit(); }

libMesh::DefaultCoupling::mesh_reinit

virtual void mesh_reinit() override

Definition: default_coupling.C:52

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

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

 {
   _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 185 of file ghosting_functor.h.

185 {};

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

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

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

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

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

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

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

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

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

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

◆ mesh_reinit()

void libMesh::DefaultCoupling::mesh_reinit ( )

overridevirtual

If we have periodic boundaries, then we'll need the mesh to have an updated point locator whenever we're about to query them.

Reimplemented from libMesh::GhostingFunctor.

Definition at line 52 of file default_coupling.C.

References _mesh, _periodic_bcs, and libMesh::MeshBase::sub_point_locator().

Referenced by delete_remote_elements(), and redistribute().

 {
   // Unless we have periodic boundary conditions, we don't need
   // anything precomputed.
 #ifdef LIBMESH_ENABLE_PERIODIC
   if (!_periodic_bcs || _periodic_bcs->empty())
     return;
 #endif
 
   // If we do have periodic boundary conditions, 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();
 }

◆ n_levels()

unsigned int libMesh::DefaultCoupling::n_levels ( )

inline

Definition at line 61 of file default_coupling.h.

References _n_levels.

Referenced by set_n_levels().

62 { return _n_levels; }

libMesh::DefaultCoupling::_n_levels

unsigned int _n_levels

Definition: default_coupling.h:112

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

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

Definition: reference_counter.h:130

◆ operator()()

void libMesh::DefaultCoupling::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 be only the elements themselves by default, but will include side neighbors if an all-discontinuous-variable system is detected and/or if the user specified –implicit_neighbor_dofs on the command line or used set_implicit_neighbor_dofs() in their code.

Implements libMesh::GhostingFunctor.

Definition at line 73 of file default_coupling.C.

References libMesh::Elem::active_family_tree_by_neighbor(), libMesh::Elem::active_family_tree_by_topological_neighbor(), libMesh::as_range(), libMesh::Elem::neighbor_ptr(), libMesh::remote_elem, and libMesh::Elem::topological_neighbor().

 {
   LOG_SCOPE("operator()", "DefaultCoupling");
 
 #ifdef LIBMESH_ENABLE_PERIODIC
   bool check_periodic_bcs =
     (_periodic_bcs && !_periodic_bcs->empty());
 
   std::unique_ptr<PointLocatorBase> point_locator;
   if (check_periodic_bcs)
     {
       libmesh_assert(_mesh);
       point_locator = _mesh->sub_point_locator();
     }
 #endif
 
   if (!this->_n_levels)
     {
       for (const auto & elem : as_range(range_begin, range_end))
         if (elem->processor_id() != p)
           coupled_elements.insert (std::make_pair(elem,_dof_coupling));
       return;
     }
 
   typedef std::unordered_set<const Elem*> set_type;
   set_type next_elements_to_check(range_begin, range_end);
   set_type elements_to_check;
   set_type elements_checked;
 
   for (unsigned int i=0; i != this->_n_levels; ++i)
     {
       elements_to_check.swap(next_elements_to_check);
       next_elements_to_check.clear();
       elements_checked.insert(elements_to_check.begin(), elements_to_check.end());
 
       for (const auto & elem : elements_to_check)
         {
           std::vector<const Elem *> active_neighbors;
 
           if (elem->processor_id() != p)
             coupled_elements.insert (std::make_pair(elem,_dof_coupling));
 
           for (auto s : elem->side_index_range())
             {
               const Elem * neigh = elem->neighbor_ptr(s);
 
               // If we have a neighbor here
               if (neigh)
                 {
                   // Mesh ghosting might ask us about what we want to
                   // distribute along with non-local elements, and those
                   // non-local elements might have remote neighbors, and
                   // if they do then we can't say anything about them.
                   if (neigh == remote_elem)
                     continue;
                 }
 #ifdef LIBMESH_ENABLE_PERIODIC
               // We might still have a periodic neighbor here
               else if (check_periodic_bcs)
                 {
                   libmesh_assert(_mesh);
 
                   neigh = elem->topological_neighbor
                     (s, *_mesh, *point_locator, _periodic_bcs);
                 }
 #endif
 
               // With no regular *or* periodic neighbors we have nothing
               // to do.
               if (!neigh)
                 continue;
 
               // With any kind of neighbor, we need to couple to all the
               // active descendants on our side.
 #ifdef LIBMESH_ENABLE_AMR
               if (neigh == elem->neighbor_ptr(s))
                 neigh->active_family_tree_by_neighbor(active_neighbors,elem);
 #  ifdef LIBMESH_ENABLE_PERIODIC
               else
                 neigh->active_family_tree_by_topological_neighbor
                   (active_neighbors,elem,*_mesh,*point_locator,_periodic_bcs);
 #  endif
 #else
               active_neighbors.clear();
               active_neighbors.push_back(neigh);
 #endif
 
               for (const auto & neighbor : active_neighbors)
                 {
                   if (!elements_checked.count(neighbor))
                     next_elements_to_check.insert(neighbor);
 
                   if (neighbor->processor_id() != p)
                     coupled_elements.insert
                       (std::make_pair(neighbor, _dof_coupling));
                 }
             }
         }
     }
 }

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

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

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

◆ redistribute()

virtual void libMesh::DefaultCoupling::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 84 of file default_coupling.h.

References mesh_reinit().

85 { this->mesh_reinit(); }

libMesh::DefaultCoupling::mesh_reinit

virtual void mesh_reinit() override

Definition: default_coupling.C:52

◆ set_dof_coupling()

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

Definition at line 34 of file default_coupling.C.

References _dof_coupling, and libMesh::CouplingMatrix::empty().

 {
   // We used to treat an empty 0x0 _dof_coupling matrix as if it
   // were an NxN all-ones matrix.  We'd like to stop supporting this
   // behavior, but for now we'll just warn about it, while supporting
   // it via the preferred mechanism: a nullptr _dof_coupling
   // matrix pointer is interpreted as a full coupling matrix.
   if (dof_coupling && dof_coupling->empty())
     {
       libmesh_deprecated();
       _dof_coupling = nullptr;
     }
   else
     _dof_coupling = dof_coupling;
 }