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

This class implements ghosting of point neighbors (elements on the same manifold that share points), ghosting stencils out to a user-configurable number of levels of neighbors. More...

#include <point_neighbor_coupling.h>

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

 PointNeighborCoupling ()
 Constructor. More...
 
 PointNeighborCoupling (const PointNeighborCoupling &other)
 Constructor. More...
 
virtual std::unique_ptr< GhostingFunctorclone () const override
 A clone() is needed because GhostingFunctor can not be shared between different meshes. More...
 
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) override
 
virtual void mesh_reinit () override
 If we have periodic boundaries, then we'll need the mesh to have an updated point locator whenever we're about to query them. More...
 
virtual void redistribute () override
 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 () 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 the elements which will be coupled to them in the sparsity pattern. More...
 
virtual void set_mesh (const MeshBase *mesh)
 It should be called after cloning a ghosting functor. More...
 
const MeshBaseget_mesh () const
 Return the mesh associated with ghosting functor. 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...
 

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

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 CouplingMatrix_dof_coupling
 
const PeriodicBoundaries_periodic_bcs
 
unsigned int _n_levels
 

Detailed Description

This class implements ghosting of point neighbors (elements on the same manifold that share points), ghosting stencils out to a user-configurable number of levels of neighbors.

Author
Roy H. Stogner
Date
2016

Definition at line 44 of file point_neighbor_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 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.

Constructor & Destructor Documentation

◆ PointNeighborCoupling() [1/2]

libMesh::PointNeighborCoupling::PointNeighborCoupling ( )
inline

Constructor.

Definition at line 51 of file point_neighbor_coupling.h.

51  :
52  _dof_coupling(nullptr),
53 #ifdef LIBMESH_ENABLE_PERIODIC
54  _periodic_bcs(nullptr),
55 #endif
56  _n_levels(0)
57  {}
const PeriodicBoundaries * _periodic_bcs

◆ PointNeighborCoupling() [2/2]

libMesh::PointNeighborCoupling::PointNeighborCoupling ( const PointNeighborCoupling other)
inline

Constructor.

Definition at line 62 of file point_neighbor_coupling.h.

62  :
63  GhostingFunctor(other),
64  _dof_coupling(other._dof_coupling),
65 #ifdef LIBMESH_ENABLE_PERIODIC
66  _periodic_bcs(other._periodic_bcs),
67 #endif
68  _n_levels(other._n_levels)
69  {}
GhostingFunctor()
Constructor.
const PeriodicBoundaries * _periodic_bcs

Member Function Documentation

◆ clone()

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

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

The operations in GhostingFunctor are mesh dependent.

Reimplemented from libMesh::GhostingFunctor.

Definition at line 75 of file point_neighbor_coupling.h.

76  { return std::make_unique<PointNeighborCoupling>(*this); }

◆ delete_remote_elements()

virtual void libMesh::PointNeighborCoupling::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 107 of file point_neighbor_coupling.h.

References mesh_reinit().

108  { this->mesh_reinit(); }
virtual void mesh_reinit() override
If we have periodic boundaries, then we&#39;ll need the mesh to have an updated point locator whenever we...

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

void libMesh::PointNeighborCoupling::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 34 of file point_neighbor_coupling.C.

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

Referenced by delete_remote_elements(), and redistribute().

35 {
36  // Unless we have periodic boundary conditions, we don't need
37  // anything precomputed.
38 #ifdef LIBMESH_ENABLE_PERIODIC
39  if (_periodic_bcs && !_periodic_bcs->empty())
40 #endif
41  {
42  // If we do have periodic boundary conditions, we'll need a master
43  // point locator, so we'd better have a mesh to build it on.
45 
46  // Make sure an up-to-date master point locator has been
47  // constructed; we'll need to grab sub-locators soon.
49  }
50 }
std::unique_ptr< PointLocatorBase > sub_point_locator() const
Definition: mesh_base.C:1638
const PeriodicBoundaries * _periodic_bcs
libmesh_assert(ctx)

◆ n_levels()

unsigned int libMesh::PointNeighborCoupling::n_levels ( )
inline

Definition at line 83 of file point_neighbor_coupling.h.

References _n_levels.

Referenced by set_n_levels().

84  { return _n_levels; }

◆ 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::PointNeighborCoupling::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 include the point neighbors, point neighbors of point neighbors, etc, to n_levels depth.

Implements libMesh::GhostingFunctor.

Definition at line 55 of file point_neighbor_coupling.C.

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

59 {
60  LOG_SCOPE("operator()", "PointNeighborCoupling");
61 
62  // Take out of libmesh_assert for an API integration
63  //libmesh_assert(_mesh);
64 
65 #ifdef LIBMESH_ENABLE_PERIODIC
66  bool check_periodic_bcs =
67  (_periodic_bcs && !_periodic_bcs->empty());
68  std::unique_ptr<PointLocatorBase> point_locator;
69  if (check_periodic_bcs)
70  {
72  point_locator = _mesh->sub_point_locator();
73  }
74 #endif
75 
76  if (!this->_n_levels)
77  {
78  for (const auto & elem : as_range(range_begin, range_end))
79  {
80  //libmesh_assert(_mesh->query_elem_ptr(elem->id()) == elem);
81  if (elem->processor_id() != p)
82  coupled_elements.emplace(elem, _dof_coupling);
83  }
84 
85  return;
86  }
87 
88  typedef std::unordered_set<const Elem*> set_type;
89  set_type next_elements_to_check(range_begin, range_end);
90  set_type elements_to_check;
91  set_type elements_checked;
92 
93  for (unsigned int i=0; i != this->_n_levels; ++i)
94  {
95  elements_to_check.swap(next_elements_to_check);
96  next_elements_to_check.clear();
97  elements_checked.insert(elements_to_check.begin(), elements_to_check.end());
98 
99  for (const auto & elem : elements_to_check)
100  {
101  std::set<const Elem *> point_neighbors;
102  //libmesh_assert(_mesh->query_elem_ptr(elem->id()) == elem);
103 
104  if (elem->processor_id() != p)
105  coupled_elements.emplace(elem, _dof_coupling);
106 
107 #ifdef LIBMESH_ENABLE_PERIODIC
108  // We might have a periodic neighbor here
109  if (check_periodic_bcs)
110  {
111  libmesh_not_implemented();
112  }
113  else
114 #endif
115  {
116  elem->find_point_neighbors(point_neighbors);
117  }
118 
119  for (const auto & neighbor : point_neighbors)
120  {
121  if (!elements_checked.count(neighbor))
122  next_elements_to_check.insert(neighbor);
123 
124  if (neighbor->processor_id() != p)
125  coupled_elements.emplace(neighbor, _dof_coupling);
126  }
127  }
128  }
129 }
std::unique_ptr< PointLocatorBase > sub_point_locator() const
Definition: mesh_base.C:1638
const PeriodicBoundaries * _periodic_bcs
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)

◆ 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::PointNeighborCoupling::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 104 of file point_neighbor_coupling.h.

References mesh_reinit().

105  { this->mesh_reinit(); }
virtual void mesh_reinit() override
If we have periodic boundaries, then we&#39;ll need the mesh to have an updated point locator whenever we...

◆ set_dof_coupling()

void libMesh::PointNeighborCoupling::set_dof_coupling ( const CouplingMatrix dof_coupling)
inline

Definition at line 79 of file point_neighbor_coupling.h.

References _dof_coupling.

Referenced by PointNeighborCouplingTest::testCoupling().

80  { _dof_coupling = dof_coupling; }

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

void libMesh::PointNeighborCoupling::set_n_levels ( unsigned int  n_levels)
inline

◆ set_periodic_boundaries()

void libMesh::PointNeighborCoupling::set_periodic_boundaries ( const PeriodicBoundaries periodic_bcs)
inlineoverridevirtual

Reimplemented from libMesh::GhostingFunctor.

Definition at line 94 of file point_neighbor_coupling.h.

References _periodic_bcs.

95  { _periodic_bcs = periodic_bcs; }
const PeriodicBoundaries * _periodic_bcs

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

◆ _dof_coupling

const CouplingMatrix* libMesh::PointNeighborCoupling::_dof_coupling
private

Definition at line 124 of file point_neighbor_coupling.h.

Referenced by set_dof_coupling().

◆ _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_levels

unsigned int libMesh::PointNeighborCoupling::_n_levels
private

Definition at line 128 of file point_neighbor_coupling.h.

Referenced by n_levels(), and set_n_levels().

◆ _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::PointNeighborCoupling::_periodic_bcs
private

Definition at line 126 of file point_neighbor_coupling.h.

Referenced by mesh_reinit(), and set_periodic_boundaries().


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