libMesh
|
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>
Public Types | |
typedef std::map< const Elem *, const CouplingMatrix *, CompareDofObjectsByPIDAndThenID > | 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... | |
DefaultCoupling (const DefaultCoupling &other) | |
Constructor. More... | |
virtual std::unique_ptr< GhostingFunctor > | clone () 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 MeshBase * | get_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 |
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.
Definition at line 44 of file default_coupling.h.
|
protectedinherited |
Data structure to log the information.
The log is identified by the class name.
Definition at line 119 of file reference_counter.h.
|
inherited |
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.
|
inline |
Constructor.
Definition at line 51 of file default_coupling.h.
|
inline |
Constructor.
Definition at line 62 of file default_coupling.h.
|
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 default_coupling.h.
|
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 104 of file default_coupling.h.
References mesh_reinit().
|
staticinherited |
Definition at line 100 of file reference_counter.C.
References libMesh::ReferenceCounter::_enable_print_counter.
|
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.
|
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.
|
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().
|
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().
|
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().
|
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().
|
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 53 of file default_coupling.C.
References libMesh::GhostingFunctor::_mesh, _periodic_bcs, libMesh::libmesh_assert(), and libMesh::MeshBase::sub_point_locator().
Referenced by delete_remote_elements(), and redistribute().
|
inline |
Definition at line 82 of file default_coupling.h.
References _n_levels.
Referenced by set_n_levels().
|
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().
|
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.
Definition at line 74 of file default_coupling.C.
References libMesh::Elem::active_family_tree_by_neighbor(), libMesh::Elem::active_family_tree_by_topological_neighbor(), libMesh::as_range(), libMesh::libmesh_assert(), libMesh::Elem::neighbor_ptr(), libMesh::remote_elem, and libMesh::Elem::topological_neighbor().
|
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().
|
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 101 of file default_coupling.h.
References mesh_reinit().
void libMesh::DefaultCoupling::set_dof_coupling | ( | const CouplingMatrix * | dof_coupling | ) |
Definition at line 35 of file default_coupling.C.
References _dof_coupling, and libMesh::CouplingMatrix::empty().
|
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().
|
inline |
Definition at line 86 of file default_coupling.h.
References _n_levels, and n_levels().
Referenced by main(), and DefaultCouplingTest::testCoupling().
|
inlineoverridevirtual |
Reimplemented from libMesh::GhostingFunctor.
Definition at line 91 of file default_coupling.h.
References _periodic_bcs.
|
staticprotectedinherited |
Actually holds the data.
Definition at line 124 of file reference_counter.h.
Referenced by libMesh::ReferenceCounter::get_info().
|
private |
Definition at line 124 of file default_coupling.h.
Referenced by set_dof_coupling().
|
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().
|
protectedinherited |
Definition at line 291 of file ghosting_functor.h.
Referenced by libMesh::GhostingFunctor::get_mesh(), mesh_reinit(), libMesh::PointNeighborCoupling::mesh_reinit(), and libMesh::GhostingFunctor::set_mesh().
|
staticprotectedinherited |
Mutual exclusion object to enable thread-safe reference counting.
Definition at line 137 of file reference_counter.h.
|
private |
Definition at line 128 of file default_coupling.h.
Referenced by n_levels(), and set_n_levels().
|
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().
|
private |
Definition at line 126 of file default_coupling.h.
Referenced by mesh_reinit(), and set_periodic_boundaries().