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::DefaultCoupling Class Reference

This class implements the default algebraic coupling in libMesh: elements couple to themselves, but may also couple to neighbors both locally and across periodic boundary conditions. More...

#include <default_coupling.h>

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

 DefaultCoupling ()
 Constructor. 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)
 
void set_mesh (const MeshBase *mesh)
 
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 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=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
 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
 
const MeshBase_mesh
 
unsigned int _n_levels
 

Detailed Description

This class implements the default algebraic coupling in libMesh: elements couple to themselves, but may also couple to neighbors both locally and across periodic boundary conditions.

Author
Roy H. Stogner
Date
2016

Definition at line 41 of file default_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 117 of file reference_counter.h.

◆ map_type

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

Constructor & Destructor Documentation

◆ DefaultCoupling()

libMesh::DefaultCoupling::DefaultCoupling ( )

Constructor.

Definition at line 48 of file default_coupling.h.

48  :
49  _dof_coupling(nullptr),
50 #ifdef LIBMESH_ENABLE_PERIODIC
51  _periodic_bcs(nullptr),
52 #endif
53  _mesh(nullptr),
54  _n_levels(0)
55  {}
const CouplingMatrix * _dof_coupling
const PeriodicBoundaries * _periodic_bcs

Member Function Documentation

◆ delete_remote_elements()

virtual void libMesh::DefaultCoupling::delete_remote_elements ( )
overridevirtual

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 87 of file default_coupling.h.

References mesh_reinit().

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

static void libMesh::ReferenceCounter::disable_print_counter_info ( )
staticinherited

◆ dofmap_reinit()

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

185 {};

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )
staticinherited

Methods to enable/disable the reference counter output from print_info()

◆ get_info()

static std::string libMesh::ReferenceCounter::get_info ( )
staticinherited

Gets a string containing the reference information.

◆ increment_constructor_count()

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

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

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

182 {
183  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
184  std::pair<unsigned int, unsigned int> & p = _counts[name];
185 
186  p.first++;
187 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ increment_destructor_count()

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

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

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

195 {
196  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
197  std::pair<unsigned int, unsigned int> & p = _counts[name];
198 
199  p.second++;
200 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ mesh_reinit()

virtual void libMesh::DefaultCoupling::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.

Referenced by delete_remote_elements(), and redistribute().

◆ n_levels()

unsigned int libMesh::DefaultCoupling::n_levels ( )

Definition at line 61 of file default_coupling.h.

References _n_levels.

Referenced by set_n_levels().

62  { return _n_levels; }

◆ n_objects()

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

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

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

◆ operator()()

virtual void libMesh::DefaultCoupling::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 be only the elements themselves by default, but will include side neighbors if an all-discontinuous-variable system is detected and/or if the user specified –implicit_neighbor_dofs on the command line or used set_implicit_neighbor_dofs() in their code.

Implements libMesh::GhostingFunctor.

◆ print_info()

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

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

◆ redistribute()

virtual void libMesh::DefaultCoupling::redistribute ( )
overridevirtual

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 84 of file default_coupling.h.

References mesh_reinit().

85  { 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::DefaultCoupling::set_dof_coupling ( const CouplingMatrix dof_coupling)

◆ set_mesh()

void libMesh::DefaultCoupling::set_mesh ( const MeshBase mesh)

Definition at line 75 of file default_coupling.h.

References _mesh.

76  { _mesh = mesh; }

◆ set_n_levels()

void libMesh::DefaultCoupling::set_n_levels ( unsigned int  n_levels)

Definition at line 65 of file default_coupling.h.

References _n_levels, and n_levels().

◆ set_periodic_boundaries()

void libMesh::DefaultCoupling::set_periodic_boundaries ( const PeriodicBoundaries periodic_bcs)

Definition at line 70 of file default_coupling.h.

References _periodic_bcs.

71  { _periodic_bcs = periodic_bcs; }
const PeriodicBoundaries * _periodic_bcs

Member Data Documentation

◆ _counts

Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited

◆ _dof_coupling

const CouplingMatrix* libMesh::DefaultCoupling::_dof_coupling
private

Definition at line 107 of file default_coupling.h.

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter
staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

◆ _mesh

const MeshBase* libMesh::DefaultCoupling::_mesh
private

Definition at line 111 of file default_coupling.h.

Referenced by set_mesh().

◆ _mutex

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

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_levels

unsigned int libMesh::DefaultCoupling::_n_levels
private

Definition at line 112 of file default_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 130 of file reference_counter.h.

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

◆ _periodic_bcs

const PeriodicBoundaries* libMesh::DefaultCoupling::_periodic_bcs
private

Definition at line 109 of file default_coupling.h.

Referenced by set_periodic_boundaries().


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