libMesh
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Attributes | Private Attributes | List of all members
libMesh::GhostPointNeighbors Class Reference

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

#include <ghost_point_neighbors.h>

Inheritance diagram for libMesh::GhostPointNeighbors:
[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

 GhostPointNeighbors (const MeshBase &mesh)
 Constructor. More...
 
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)
 For the specified range of active elements, find their point neighbors and interior_parent elements, ignoring those on processor 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

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

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

Constructor & Destructor Documentation

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

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

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

Definition at line 107 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

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

108 {
109  _enable_print_counter = false;
110  return;
111 }
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...
virtual void libMesh::GhostingFunctor::dofmap_reinit ( )
virtualinherited

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

References libMesh::ReferenceCounter::_enable_print_counter.

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

102 {
103  _enable_print_counter = true;
104  return;
105 }
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...
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)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
static Counts _counts
Actually holds the data.
void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name)
protectedinherited

Increments the construction counter.

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

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

186 {
187  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
188  std::pair<unsigned int, unsigned int> & p = _counts[name];
189 
190  p.first++;
191 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition: threads.C:29
static Counts _counts
Actually holds the data.
void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name)
protectedinherited

Increments the destruction counter.

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

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

199 {
200  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
201  std::pair<unsigned int, unsigned int> & p = _counts[name];
202 
203  p.second++;
204 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition: threads.C:29
static Counts _counts
Actually holds the data.
virtual void libMesh::GhostingFunctor::mesh_reinit ( )
virtualinherited

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

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 ( )
staticinherited
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_family_tree_by_neighbor(), libMesh::Elem::dim(), libMesh::Elem::interior_parent(), libmesh_nullptr, libMesh::Elem::neighbor_ptr_range(), libMesh::Elem::node_index_range(), 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 (auto neigh : elem->neighbor_ptr_range())
71  {
72  if (neigh && neigh != remote_elem)
73  {
74 #ifdef LIBMESH_ENABLE_AMR
75  if (!neigh->active())
76  {
77  std::vector<const Elem*> family;
78  neigh->active_family_tree_by_neighbor(family, elem);
79 
80  for (std::size_t i=0; i!=family.size(); ++i)
81  if (family[i]->processor_id() != p)
82  coupled_elements.insert
83  (std::make_pair(family[i], nullcm));
84  }
85  else
86 #endif
87  if (neigh->processor_id() != p)
88  coupled_elements.insert
89  (std::make_pair(neigh, nullcm));
90  }
91  }
92 
93  // It is possible that a refined boundary element will not
94  // touch any nodes of its interior_parent, in TRI3/TET4 and in
95  // non-level-one rule cases. So we can't just rely on node
96  // connections to preserve interior_parent(). However, trying
97  // to preserve interior_parent() manually only works if it's on
98  // the same Mesh, which is *not* guaranteed! So we'll
99  // double-check later to make sure our interior parents are in
100  // the mesh before we connect them.
101  if (elem->dim() < LIBMESH_DIM &&
102  elem->interior_parent() &&
103  elem->interior_parent()->processor_id() != p)
104  interior_parents.insert (elem->interior_parent());
105 
106  // Add nodes connected to active local elements
107  for (auto n : elem->node_index_range())
108  connected_nodes.insert (elem->node_ptr(n));
109  }
110 
111  // Connect any interior_parents who are really in our mesh
112  for (const auto & elem : _mesh.element_ptr_range())
113  {
114  std::set<const Elem *>::iterator ip_it =
115  interior_parents.find(elem);
116 
117  if (ip_it != interior_parents.end())
118  {
119  coupled_elements.insert
120  (std::make_pair(elem, nullcm));
121 
122  // Shrink the set ASAP to speed up subsequent searches
123  interior_parents.erase(ip_it);
124  }
125  }
126 
127  // Connect any active elements which are connected to our range's
128  // elements' nodes by addin elements connected to nodes on active
129  // local elements.
130  for (const auto & elem : _mesh.active_element_ptr_range())
131  if (elem->processor_id() != p)
132  for (auto & n : elem->node_ref_range())
133  if (connected_nodes.count(&n))
134  coupled_elements.insert(std::make_pair(elem, nullcm));
135 }
const class libmesh_nullptr_t libmesh_nullptr
virtual SimpleRange< element_iterator > active_element_ptr_range()=0
virtual SimpleRange< element_iterator > element_ptr_range()=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  out_stream << ReferenceCounter::get_info();
92 }
static std::string get_info()
Gets a string containing the reference information.
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...
virtual void libMesh::GhostingFunctor::redistribute ( )
virtualinherited

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

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 143 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 137 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 132 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: