libMesh::GhostPointNeighbors Class Reference

#include <ghost_point_neighbors.h>

Inheritance diagram for libMesh::GhostPointNeighbors:

Public Types

typedef LIBMESH_BEST_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

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

typedef LIBMESH_BEST_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 140 of file ghosting_functor.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 43 of file ghost_point_neighbors.h.

References operator()().

43 : _mesh(mesh) {}
MeshBase & mesh

Member Function Documentation

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

Referenced by libMesh::MeshCommunication::delete_remote_elements().

190 {};
void libMesh::ReferenceCounter::disable_print_counter_info ( )
staticinherited
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 171 of file ghosting_functor.h.

Referenced by libMesh::DofMap::distribute_dofs().

171 {};
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.

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

101 {
102  _enable_print_counter = true;
103  return;
104 }
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 (Counts::iterator it = _counts.begin();
59  it != _counts.end(); ++it)
60  {
61  const std::string name(it->first);
62  const unsigned int creations = it->second.first;
63  const unsigned int destructions = it->second.second;
64 
65  oss << "| " << name << " reference count information:\n"
66  << "| Creations: " << creations << '\n'
67  << "| Destructions: " << destructions << '\n';
68  }
69 
70  oss << " ---------------------------------------------------------------------------- \n";
71 
72  return oss.str();
73 
74 #else
75 
76  return "";
77 
78 #endif
79 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:39
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 160 of file reference_counter.h.

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

Referenced by libMesh::ReferenceCounter::n_objects(), and libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

161 {
162  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
163  std::pair<unsigned int, unsigned int> & p = _counts[name];
164 
165  p.first++;
166 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:39
spin_mutex spin_mtx
Definition: threads.C:29
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 173 of file reference_counter.h.

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

Referenced by libMesh::ReferenceCounter::n_objects(), and libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

174 {
175  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
176  std::pair<unsigned int, unsigned int> & p = _counts[name];
177 
178  p.second++;
179 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:39
spin_mutex spin_mtx
Definition: threads.C:29
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 163 of file ghosting_functor.h.

Referenced by libMesh::UnstructuredMesh::contract(), and libMesh::MeshBase::prepare_for_use().

163 {};
static unsigned int libMesh::ReferenceCounter::n_objects ( )
inlinestaticinherited
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::Elem::active(), libMesh::Elem::active_family_tree_by_neighbor(), libMesh::Elem::dim(), libMesh::Elem::interior_parent(), libmesh_nullptr, libMesh::Elem::n_nodes(), libMesh::Elem::n_sides(), libMesh::Elem::neighbor_ptr(), libMesh::Elem::node_ptr(), libMesh::processor_id(), libMesh::DofObject::processor_id(), and libMesh::remote_elem.

Referenced by GhostPointNeighbors().

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::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::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 = libmesh_nullptr;
61 
62  for (MeshBase::const_element_iterator elem_it = range_begin;
63  elem_it!=range_end; ++elem_it)
64  {
65  const Elem * elem = *elem_it;
66 
67  if (elem->processor_id() != p)
68  coupled_elements.insert (std::make_pair(elem,nullcm));
69 
70  for (unsigned int s=0; s != elem->n_sides(); ++s)
71  {
72  const Elem * neigh = elem->neighbor_ptr(s);
73  if (neigh && neigh != remote_elem)
74  {
75 #ifdef LIBMESH_ENABLE_AMR
76  if (!neigh->active())
77  {
78  std::vector<const Elem*> family;
79  neigh->active_family_tree_by_neighbor(family, elem);
80 
81  for (std::size_t i=0; i!=family.size(); ++i)
82  if (family[i]->processor_id() != p)
83  coupled_elements.insert
84  (std::make_pair(family[i], nullcm));
85  }
86  else
87 #endif
88  if (neigh->processor_id() != p)
89  coupled_elements.insert
90  (std::make_pair(neigh, nullcm));
91  }
92  }
93 
94  // It is possible that a refined boundary element will not
95  // touch any nodes of its interior_parent, in TRI3/TET4 and in
96  // non-level-one rule cases. So we can't just rely on node
97  // connections to preserve interior_parent(). However, trying
98  // to preserve interior_parent() manually only works if it's on
99  // the same Mesh, which is *not* guaranteed! So we'll
100  // double-check later to make sure our interior parents are in
101  // the mesh before we connect them.
102  if (elem->dim() < LIBMESH_DIM &&
103  elem->interior_parent() &&
104  elem->interior_parent()->processor_id() != p)
105  interior_parents.insert (elem->interior_parent());
106 
107  // Add nodes connected to active local elements
108  for (unsigned int n=0; n<elem->n_nodes(); n++)
109  connected_nodes.insert (elem->node_ptr(n));
110  }
111 
112  // Connect any interior_parents who are really in our mesh
113  {
114  MeshBase::const_element_iterator elem_it = _mesh.elements_begin();
115  const MeshBase::const_element_iterator elem_end = _mesh.elements_end();
116  for (; elem_it != elem_end; ++elem_it)
117  {
118  const Elem * elem = *elem_it;
119  std::set<const Elem *>::iterator ip_it =
120  interior_parents.find(elem);
121 
122  if (ip_it != interior_parents.end())
123  {
124  coupled_elements.insert
125  (std::make_pair(elem, nullcm));
126 
127  // Shrink the set ASAP to speed up subsequent searches
128  interior_parents.erase(ip_it);
129  }
130  }
131  }
132 
133  // Connect any active elements which are connected to our range's
134  // elements' nodes
135  {
136  MeshBase::const_element_iterator elem_it = _mesh.active_elements_begin();
137  const MeshBase::const_element_iterator elem_end = _mesh.active_elements_end();
138 
139  for (; elem_it!=elem_end; ++elem_it)
140  {
141  const Elem * elem = *elem_it;
142 
143  // Add elements connected to nodes on active local elements
144  if (elem->processor_id() != p)
145  for (unsigned int n=0; n<elem->n_nodes(); n++)
146  if (connected_nodes.count(elem->node_ptr(n)))
147  coupled_elements.insert
148  (std::make_pair(elem, nullcm));
149  }
150  }
151 }
const class libmesh_nullptr_t libmesh_nullptr
virtual element_iterator elements_begin()=0
virtual element_iterator elements_end()=0
virtual element_iterator active_elements_begin()=0
virtual element_iterator active_elements_end()=0
processor_id_type processor_id()
Definition: libmesh_base.h:96
const RemoteElem * remote_elem
Definition: remote_elem.C:57
void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out)
staticinherited

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

Definition at line 88 of file reference_counter.C.

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

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

89 {
91 }
static std::string get_info()
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 183 of file ghosting_functor.h.

Referenced by libMesh::MeshCommunication::redistribute().

183 {};

Member Data Documentation

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited
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 134 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

const MeshBase& libMesh::GhostPointNeighbors::_mesh
private

Definition at line 57 of file ghost_point_neighbors.h.

Threads::spin_mutex libMesh::ReferenceCounter::_mutex
staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 128 of file reference_counter.h.

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 123 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: