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

This class implements the original default geometry ghosting requirements in libMesh: point neighbors on the same manifold, and interior_parent elements. More...

#include <ghost_point_neighbors.h>

Inheritance diagram for libMesh::GhostPointNeighbors:
[legend]

Public Types

typedef std::map< const Elem *, const CouplingMatrix *, CompareDofObjectsByPIDAndThenIDmap_type
 What elements do we care about and what variables do we care about on each element? More...
 

Public Member Functions

virtual void delete_remote_elements () override
 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...
 
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
 For the specified range of active elements, find their point neighbors and interior_parent elements, ignoring those on processor p. More...
 
virtual std::unique_ptr< GhostingFunctorclone () const
 A clone() is needed because GhostingFunctor can not be shared between different meshes. More...
 
virtual void set_mesh (const MeshBase *mesh)
 It should be called after cloning a ghosting functor. More...
 
virtual void set_periodic_boundaries (const PeriodicBoundaries *)
 
const MeshBaseget_mesh () const
 Return the mesh associated with ghosting functor. 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...
 

Static Public Member Functions

static std::string get_info ()
 Gets a string containing the reference information. More...
 
static void print_info (std::ostream &out_stream=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 ()
 

Public Attributes

virtual GhostPointNeighbors(const MeshBase &mesh) void redistribute () override
 Constructor. More...
 

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) noexcept
 Increments the construction counter. More...
 
void increment_destructor_count (const std::string &name) noexcept
 Increments the destruction counter. More...
 

Protected Attributes

const MeshBase_mesh
 

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 PeriodicBoundaries_periodic_bcs
 

Detailed Description

This class implements the original default geometry ghosting requirements in libMesh: point neighbors on the same manifold, and interior_parent elements.

Author
Roy H. Stogner
Date
2016

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

◆ map_type

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

Definition at line 241 of file ghosting_functor.h.

Member Function Documentation

◆ clone()

virtual std::unique_ptr<GhostingFunctor> libMesh::GhostingFunctor::clone ( ) const
inlinevirtualinherited

A clone() is needed because GhostingFunctor can not be shared between different meshes.

The operations in GhostingFunctor are mesh dependent.

Reimplemented in libMesh::DefaultCoupling, libMesh::PointNeighborCoupling, and libMesh::SiblingCoupling.

Definition at line 215 of file ghosting_functor.h.

Referenced by libMesh::MeshBase::MeshBase().

219  { return nullptr; }

◆ delete_remote_elements()

virtual void libMesh::GhostPointNeighbors::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 94 of file ghost_point_neighbors.h.

References libMesh::GhostingFunctor::mesh_reinit().

95  { this->mesh_reinit(); }
virtual void mesh_reinit()
GhostingFunctor subclasses which cache data will need to initialize that cache.

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )
staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

101 {
102  _enable_print_counter = false;
103  return;
104 }
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...

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

272 {};

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

References libMesh::ReferenceCounter::_enable_print_counter.

95 {
96  _enable_print_counter = true;
97  return;
98 }
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...

◆ 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 & [name, cd] : _counts)
59  oss << "| " << name << " reference count information:\n"
60  << "| Creations: " << cd.first << '\n'
61  << "| Destructions: " << cd.second << '\n';
62 
63  oss << " ---------------------------------------------------------------------------- \n";
64 
65  return oss.str();
66 
67 #else
68 
69  return "";
70 
71 #endif
72 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:42
static Counts _counts
Actually holds the data.

◆ get_mesh()

const MeshBase* libMesh::GhostingFunctor::get_mesh ( ) const
inlineinherited

Return the mesh associated with ghosting functor.

Definition at line 235 of file ghosting_functor.h.

References libMesh::GhostingFunctor::_mesh, and libMesh::libmesh_assert().

235 { libmesh_assert(_mesh); return _mesh; }
libmesh_assert(ctx)

◆ increment_constructor_count()

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

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

184 {
185  libmesh_try
186  {
187  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
188  std::pair<unsigned int, unsigned int> & p = _counts[name];
189  p.first++;
190  }
191  libmesh_catch (...)
192  {
193  auto stream = libMesh::err.get();
194  stream->exceptions(stream->goodbit); // stream must not throw
195  libMesh::err << "Encountered unrecoverable error while calling "
196  << "ReferenceCounter::increment_constructor_count() "
197  << "for a(n) " << name << " object." << std::endl;
198  std::terminate();
199  }
200 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:42
OStreamProxy err
static Counts _counts
Actually holds the data.
streamT * get()
Rather than implement every ostream/ios/ios_base function, we&#39;ll be lazy and make esoteric uses go th...
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition: threads.C:30

◆ increment_destructor_count()

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

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

208 {
209  libmesh_try
210  {
211  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
212  std::pair<unsigned int, unsigned int> & p = _counts[name];
213  p.second++;
214  }
215  libmesh_catch (...)
216  {
217  auto stream = libMesh::err.get();
218  stream->exceptions(stream->goodbit); // stream must not throw
219  libMesh::err << "Encountered unrecoverable error while calling "
220  << "ReferenceCounter::increment_destructor_count() "
221  << "for a(n) " << name << " object." << std::endl;
222  std::terminate();
223  }
224 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:42
OStreamProxy err
static Counts _counts
Actually holds the data.
streamT * get()
Rather than implement every ostream/ios/ios_base function, we&#39;ll be lazy and make esoteric uses go th...
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition: threads.C:30

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

Referenced by delete_remote_elements().

264 {};

◆ n_objects()

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

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

Definition at line 85 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

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

86  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of 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 
)
overridevirtual

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 38 of file ghost_point_neighbors.C.

References libMesh::Elem::active_family_tree_by_topological_neighbor(), libMesh::as_range(), libMesh::BoundaryInfo::boundary_ids(), libMesh::Elem::find_point_neighbors(), libMesh::DofObject::id(), libMesh::Elem::interior_parent(), libMesh::libmesh_assert(), libMesh::DofObject::processor_id(), libMesh::remote_elem, and libMesh::Elem::topological_neighbor().

42 {
44 
45 #ifdef LIBMESH_ENABLE_PERIODIC
46  bool check_periodic_bcs =
47  (_periodic_bcs && !_periodic_bcs->empty());
48 
49  std::unique_ptr<PointLocatorBase> point_locator;
50  if (check_periodic_bcs)
51  point_locator = _mesh->sub_point_locator();
52 
53  std::set<const Elem *> periodic_elems_examined;
54  const BoundaryInfo & binfo = _mesh->get_boundary_info();
55  std::vector<boundary_id_type> appn_bcids;
56  std::vector<const Elem *> active_periodic_neighbors;
57 #endif
58 
59  // Using a connected_nodes set rather than point_neighbors() would
60  // give us correct results even in corner cases, such as where two
61  // elements meet only at a corner. ;-)
62  //
63  // std::unordered_set<const Node *> connected_nodes;
64  //
65  // Unfortunately, it's not a *fast* enough test to use on a
66  // ReplicatedMesh (where it's O(Nprocs) times slower), or as a
67  // coupling functor (where it's O(Nelem/Nprocs) times slower), or as
68  // a coupling functor on a ReplicatedMesh (where you might as well
69  // just give up now)
70 
71  // Links between boundary and interior elements on mixed
72  // dimensional meshes also give us correct ghosting in this way.
73  std::unordered_set<const Elem *> interior_parents;
74 
75  // We also preserve neighbors and their neighboring children for
76  // active local elements - in most cases this is redundant with the
77  // node check, but for non-conforming Tet4 meshes and
78  // non-level-one-conforming 2D+3D meshes it is possible for an
79  // element and its coarse neighbor to not share any vertices.
80  //
81  // We also preserve interior parents for active pid elements
82 
83 
84  // This code is just for geometric coupling, so we use a null
85  // CouplingMatrix pointer. We'll declare that here so as to avoid
86  // confusing the insert() calls later.
87  CouplingMatrix * nullcm = nullptr;
88 
89  for (const auto & elem : as_range(range_begin, range_end))
90  {
91  libmesh_assert(_mesh->query_elem_ptr(elem->id()) == elem);
92 
93  if (elem->processor_id() != p)
94  coupled_elements.emplace(elem, nullcm);
95 
96  std::set<const Elem *> elem_point_neighbors;
97  elem->find_point_neighbors(elem_point_neighbors);
98 
99  for (const auto & neigh : elem_point_neighbors)
100  if (neigh->processor_id() != p)
101  coupled_elements.emplace(neigh, nullcm);
102 
103  // An interior_parent isn't on the same manifold so won't be
104  // found as a point neighbor, and it may not share nodes so we
105  // can't use a connected_nodes test.
106  //
107  // Trying to preserve interior_parent() only works if it's on
108  // the same Mesh, which is *not* guaranteed! So we'll
109  // double-check.
110  const Elem * ip = elem->interior_parent();
111  if (ip && ip->processor_id() != p &&
112  _mesh->query_elem_ptr(ip->id()) == ip)
113  coupled_elements.emplace(ip, nullcm);
114 
115 #ifdef LIBMESH_ENABLE_PERIODIC
116  if (check_periodic_bcs)
117  {
118  for (const auto s : elem->side_index_range())
119  {
120  if (elem->neighbor_ptr(s))
121  continue;
122 
123  const Elem * const equal_level_periodic_neigh = elem->topological_neighbor
124  (s, *_mesh, *point_locator, _periodic_bcs);
125 
126  if (!equal_level_periodic_neigh || equal_level_periodic_neigh == remote_elem)
127  continue;
128 
129 #ifdef LIBMESH_ENABLE_AMR
130  equal_level_periodic_neigh->active_family_tree_by_topological_neighbor(
131  active_periodic_neighbors,
132  elem,
133  *_mesh,
134  *point_locator,
136  /*reset=*/true);
137 #else
138  active_periodic_neighbors = { equal_level_periodic_neigh };
139 #endif
140 
141  for (const Elem * const active_periodic_neigh : active_periodic_neighbors)
142  {
143  std::set <const Elem *> active_periodic_point_neighbors;
144 
145  // This fills point neighbors *including*
146  // active_periodic_neigh. The documentation for this method
147  // states that this will return *active* point neighbors
148  active_periodic_neigh->find_point_neighbors(active_periodic_point_neighbors);
149 
150  for (const Elem * const appn : active_periodic_point_neighbors)
151  {
152  // Don't need to ghost RemoteElem or an element we already own or an
153  // element we've already examined
154  if (appn == remote_elem || appn->processor_id() == p ||
155  periodic_elems_examined.count(appn))
156  continue;
157 
158  // We only need to keep point neighbors that are along the periodic boundaries
159  bool on_periodic_boundary = false;
160  for (const auto appn_s : appn->side_index_range())
161  {
162  binfo.boundary_ids(appn, appn_s, appn_bcids);
163  for (const auto appn_bcid : appn_bcids)
164  if (_periodic_bcs->find(appn_bcid) != _periodic_bcs->end())
165  {
166  on_periodic_boundary = true;
167  goto jump;
168  }
169  }
170  jump:
171  if (on_periodic_boundary)
172  coupled_elements.emplace(appn, nullcm);
173 
174  periodic_elems_examined.insert(appn);
175  }
176  }
177  }
178  }
179 #endif // LIBMESH_ENABLE_PERIODIC
180  }
181 }
std::unique_ptr< PointLocatorBase > sub_point_locator() const
Definition: mesh_base.C:1565
const PeriodicBoundaries * _periodic_bcs
const BoundaryInfo & get_boundary_info() const
The information about boundary ids on the mesh.
Definition: mesh_base.h:159
SimpleRange< IndexType > as_range(const std::pair< IndexType, IndexType > &p)
Helper function that allows us to treat a homogenous pair as a range.
Definition: simple_range.h:57
libmesh_assert(ctx)
virtual const Elem * query_elem_ptr(const dof_id_type i) const =0
processor_id_type processor_id() const
Definition: dof_object.h:898
const RemoteElem * remote_elem
Definition: remote_elem.C:54

◆ print_info()

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

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

Definition at line 81 of file reference_counter.C.

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

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

82 {
84  out_stream << ReferenceCounter::get_info();
85 }
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...

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

284 {};

◆ set_mesh()

virtual void libMesh::GhostingFunctor::set_mesh ( const MeshBase mesh)
inlinevirtualinherited

It should be called after cloning a ghosting functor.

Ghosting functor is mesh dependent

Definition at line 225 of file ghosting_functor.h.

References libMesh::GhostingFunctor::_mesh, and mesh.

Referenced by libMesh::DofMap::add_algebraic_ghosting_functor(), and libMesh::DofMap::add_coupling_functor().

225 { _mesh = mesh; }
MeshBase & mesh

◆ set_periodic_boundaries()

virtual void libMesh::GhostingFunctor::set_periodic_boundaries ( const PeriodicBoundaries )
inlinevirtualinherited

Reimplemented in libMesh::PointNeighborCoupling, and libMesh::DefaultCoupling.

Definition at line 229 of file ghosting_functor.h.

229 {}

Member Data Documentation

◆ _counts

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

Actually holds the data.

Definition at line 124 of file reference_counter.h.

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

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

◆ _mesh

const MeshBase* libMesh::GhostingFunctor::_mesh
protectedinherited

◆ _mutex

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.

◆ _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 132 of file reference_counter.h.

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

◆ _periodic_bcs

const PeriodicBoundaries* libMesh::GhostPointNeighbors::_periodic_bcs
private

Definition at line 109 of file ghost_point_neighbors.h.

◆ redistribute

virtual GhostPointNeighbors (const MeshBase & mesh) void libMesh::GhostPointNeighbors::redistribute() override
inlineoverride

Constructor.

Constructor. A clone() is needed because GhostingFunctor can not be shared between different meshes. The operations in GhostingFunctor are mesh dependent. If we have periodic boundaries, then we'll need the mesh to have an updated point locator whenever we're about to query them.

Definition at line 91 of file ghost_point_neighbors.h.

92  { this->mesh_reinit(); }
virtual void mesh_reinit()
GhostingFunctor subclasses which cache data will need to initialize that cache.

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