libMesh::GhostPointNeighbors Class Reference

#include <ghost_point_neighbors.h>

Inheritance diagram for libMesh::GhostPointNeighbors:

Public Types

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

Public Member Functions

 GhostPointNeighbors (const MeshBase &mesh)
 
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)
 
virtual void mesh_reinit ()
 
virtual void dofmap_reinit ()
 
virtual void redistribute ()
 
virtual void delete_remote_elements ()
 

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 MeshBase_mesh
 

Detailed Description

This class implements the default geometry ghosting in libMesh: point neighbors and interior_parent elements are ghosted.

Author
Roy H. Stogner
Date
2016

Definition at line 36 of file ghost_point_neighbors.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

◆ GhostPointNeighbors()

libMesh::GhostPointNeighbors::GhostPointNeighbors ( const MeshBase mesh)
inline

Constructor.

Definition at line 43 of file ghost_point_neighbors.h.

43 : _mesh(mesh) {}
MeshBase & mesh

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

204 {};

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

107 {
108  _enable_print_counter = false;
109  return;
110 }

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

101 {
102  _enable_print_counter = true;
103  return;
104 }

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

48 {
49 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
50 
51  std::ostringstream oss;
52 
53  oss << '\n'
54  << " ---------------------------------------------------------------------------- \n"
55  << "| Reference count information |\n"
56  << " ---------------------------------------------------------------------------- \n";
57 
58  for (const auto & pr : _counts)
59  {
60  const std::string name(pr.first);
61  const unsigned int creations = pr.second.first;
62  const unsigned int destructions = pr.second.second;
63 
64  oss << "| " << name << " reference count information:\n"
65  << "| Creations: " << creations << '\n'
66  << "| Destructions: " << destructions << '\n';
67  }
68 
69  oss << " ---------------------------------------------------------------------------- \n";
70 
71  return oss.str();
72 
73 #else
74 
75  return "";
76 
77 #endif
78 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42

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

182 {
183  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
184  std::pair<unsigned int, unsigned int> & p = _counts[name];
185 
186  p.first++;
187 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42
spin_mutex spin_mtx
Definition: threads.C:29

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

195 {
196  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
197  std::pair<unsigned int, unsigned int> & p = _counts[name];
198 
199  p.second++;
200 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42
spin_mutex spin_mtx
Definition: threads.C:29

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

Definition at line 177 of file ghosting_functor.h.

177 {};

◆ 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; }
static Threads::atomic< unsigned int > _n_objects

◆ operator()()

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

For the specified range of active elements, find their point neighbors and interior_parent elements, ignoring those on processor p.

Implements libMesh::GhostingFunctor.

Definition at line 33 of file ghost_point_neighbors.C.

References libMesh::as_range(), and libMesh::remote_elem.

37 {
38  // Using the connected_nodes set rather than point_neighbors() gives
39  // us correct results even in corner cases, such as where two
40  // elements meet only at a corner. ;-)
41 
42  std::unordered_set<const Node *> connected_nodes;
43 
44  // Links between boundary and interior elements on mixed
45  // dimensional meshes also give us correct ghosting in this way.
46  std::unordered_set<const Elem *> interior_parents;
47 
48  // We also preserve neighbors and their neighboring children for
49  // active local elements - in most cases this is redundant with the
50  // node check, but for non-conforming Tet4 meshes and
51  // non-level-one-conforming 2D+3D meshes it is possible for an
52  // element and its coarse neighbor to not share any vertices.
53  //
54  // We also preserve interior parents for active pid elements
55 
56 
57  // This code is just for geometric coupling, so we use a null
58  // CouplingMatrix pointer. We'll declare that here so as to avoid
59  // confusing the insert() calls later.
60  CouplingMatrix * nullcm = nullptr;
61 
62  for (const auto & elem : as_range(range_begin, range_end))
63  {
64  if (elem->processor_id() != p)
65  coupled_elements.insert (std::make_pair(elem,nullcm));
66 
67  for (auto neigh : elem->neighbor_ptr_range())
68  {
69  if (neigh && neigh != remote_elem)
70  {
71 #ifdef LIBMESH_ENABLE_AMR
72  if (!neigh->active())
73  {
74  std::vector<const Elem*> family;
75  neigh->active_family_tree_by_neighbor(family, elem);
76 
77  for (const Elem * f : family)
78  if (f->processor_id() != p)
79  coupled_elements.insert
80  (std::make_pair(f, nullcm));
81  }
82  else
83 #endif
84  if (neigh->processor_id() != p)
85  coupled_elements.insert
86  (std::make_pair(neigh, nullcm));
87  }
88  }
89 
90  // It is possible that a refined boundary element will not
91  // touch any nodes of its interior_parent, in TRI3/TET4 and in
92  // non-level-one rule cases. So we can't just rely on node
93  // connections to preserve interior_parent(). However, trying
94  // to preserve interior_parent() manually only works if it's on
95  // the same Mesh, which is *not* guaranteed! So we'll
96  // double-check later to make sure our interior parents are in
97  // the mesh before we connect them.
98  if (elem->dim() < LIBMESH_DIM &&
99  elem->interior_parent() &&
100  elem->interior_parent()->processor_id() != p)
101  interior_parents.insert (elem->interior_parent());
102 
103  // Add nodes connected to active local elements
104  for (auto n : elem->node_index_range())
105  connected_nodes.insert (elem->node_ptr(n));
106  }
107 
108  // Connect any interior_parents who are really in our mesh
109  for (const auto & elem : _mesh.element_ptr_range())
110  {
111  std::unordered_set<const Elem *>::iterator ip_it =
112  interior_parents.find(elem);
113 
114  if (ip_it != interior_parents.end())
115  {
116  coupled_elements.insert
117  (std::make_pair(elem, nullcm));
118 
119  // Shrink the set ASAP to speed up subsequent searches
120  interior_parents.erase(ip_it);
121  }
122  }
123 
124  // Connect any active elements which are connected to our range's
125  // elements' nodes by addin elements connected to nodes on active
126  // local elements.
127  for (const auto & elem : _mesh.active_element_ptr_range())
128  if (elem->processor_id() != p)
129  for (auto & n : elem->node_ref_range())
130  if (connected_nodes.count(&n))
131  coupled_elements.insert(std::make_pair(elem, nullcm));
132 }
virtual SimpleRange< element_iterator > active_element_ptr_range()=0
virtual SimpleRange< element_iterator > element_ptr_range()=0
SimpleRange< I > as_range(const std::pair< I, I > &p)
Definition: simple_range.h:57
const RemoteElem * remote_elem
Definition: remote_elem.C:57

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

88 {
90  out_stream << ReferenceCounter::get_info();
91 }
static std::string 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 libMesh::PointNeighborCoupling, and libMesh::DefaultCoupling.

Definition at line 197 of file ghosting_functor.h.

197 {};

Member Data Documentation

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited

◆ _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& libMesh::GhostPointNeighbors::_mesh
private

Definition at line 57 of file ghost_point_neighbors.h.

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


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