libMesh::SiblingCoupling Class Reference

#include <sibling_coupling.h>

Inheritance diagram for libMesh::SiblingCoupling:

Public Types

typedef LIBMESH_BEST_UNORDERED_MAP< const Elem *, const CouplingMatrix * > map_type
 

Public Member Functions

 SiblingCoupling ()
 
void set_dof_coupling (const CouplingMatrix *dof_coupling)
 
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 CouplingMatrix_dof_coupling
 

Detailed Description

This class adds coupling (for use in send_list construction) between active elements and all descendants of their parent.

This may be useful when constructing projections onto the parent element for error indicator evaluation.

Author
Roy H. Stogner
Date
2016

Definition at line 39 of file sibling_coupling.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::SiblingCoupling::SiblingCoupling ( )
inline

Constructor.

Definition at line 46 of file sibling_coupling.h.

46  :
const class libmesh_nullptr_t libmesh_nullptr
const CouplingMatrix * _dof_coupling

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::SiblingCoupling::operator() ( const MeshBase::const_element_iterator range_begin,
const MeshBase::const_element_iterator range_end,
processor_id_type  p,
map_type coupled_elements 
)
virtual

For the specified range of active elements, find any sibling elements which should be evaluable too.

Implements libMesh::GhostingFunctor.

Definition at line 29 of file sibling_coupling.C.

References libMesh::Elem::active_family_tree(), libMesh::Elem::parent(), and libMesh::DofObject::processor_id().

Referenced by set_dof_coupling().

33 {
34  LOG_SCOPE("operator()", "SiblingCoupling");
35 
36  for (MeshBase::const_element_iterator elem_it = range_begin;
37  elem_it != range_end; ++elem_it)
38  {
39  std::vector<const Elem *> active_siblings;
40 
41  const Elem * const elem = *elem_it;
42 
43  const Elem * parent = elem->parent();
44  if (!parent)
45  continue;
46 
47 #ifdef LIBMESH_ENABLE_AMR
48  parent->active_family_tree(active_siblings);
49 #endif
50 
51  for (std::size_t a=0; a != active_siblings.size(); ++a)
52  {
53  const Elem * sibling = active_siblings[a];
54 
55  if (sibling->processor_id() != p)
56  coupled_elements.insert
57  (std::make_pair(sibling, _dof_coupling));
58  }
59  }
60 }
const CouplingMatrix * _dof_coupling
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 {};
void libMesh::SiblingCoupling::set_dof_coupling ( const CouplingMatrix dof_coupling)
inline

Definition at line 50 of file sibling_coupling.h.

References _dof_coupling, and operator()().

51  { _dof_coupling = dof_coupling; }
const CouplingMatrix * _dof_coupling

Member Data Documentation

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited
const CouplingMatrix* libMesh::SiblingCoupling::_dof_coupling
private

Definition at line 64 of file sibling_coupling.h.

Referenced by set_dof_coupling().

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

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: