libMesh
default_coupling.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 
20 #ifndef LIBMESH_DEFAULT_COUPLING_H
21 #define LIBMESH_DEFAULT_COUPLING_H
22 
23 // Local Includes
24 #include "libmesh/ghosting_functor.h"
25 
26 namespace libMesh
27 {
28 
29 // Forward declarations
30 class PeriodicBoundaries;
31 
32 
42 {
43 public:
44 
50 #ifdef LIBMESH_ENABLE_PERIODIC
52 #endif
54  _n_levels(0)
55  {}
56 
57  // Change coupling matrix after construction
58  void set_dof_coupling(const CouplingMatrix * dof_coupling);
59 
60  // Return number of levels of neighbors we will couple.
61  unsigned int n_levels()
62  { return _n_levels; }
63 
64  // Change number of levels of neighbors to couple.
65  void set_n_levels(unsigned int n_levels)
66  { _n_levels = n_levels; }
67 
68 #ifdef LIBMESH_ENABLE_PERIODIC
69  // Set PeriodicBoundaries to couple
70  void set_periodic_boundaries(const PeriodicBoundaries * periodic_bcs)
71  { _periodic_bcs = periodic_bcs; }
72 #endif
73 
74  // Set MeshBase for use in checking for periodic boundary ids
75  void set_mesh(const MeshBase * mesh)
76  { _mesh = mesh; }
77 
82  virtual void mesh_reinit () libmesh_override;
83 
84  virtual void redistribute () libmesh_override
85  { this->mesh_reinit(); }
86 
87  virtual void delete_remote_elements() libmesh_override
88  { this->mesh_reinit(); }
89 
100  virtual void operator() (const MeshBase::const_element_iterator & range_begin,
101  const MeshBase::const_element_iterator & range_end,
103  map_type & coupled_elements) libmesh_override;
104 
105 private:
106 
108 #ifdef LIBMESH_ENABLE_PERIODIC
110 #endif
111  const MeshBase * _mesh;
112  unsigned int _n_levels;
113 };
114 
115 } // namespace libMesh
116 
117 #endif // LIBMESH_DEFAULT_COUPLING_H
This abstract base class defines the interface by which library code and user code can report associa...
The definition of the const_element_iterator struct.
Definition: mesh_base.h:1494
We're using a class instead of a typedef to allow forward declarations and future flexibility...
void set_mesh(const MeshBase *mesh)
MeshBase & mesh
uint8_t processor_id_type
Definition: id_types.h:99
const class libmesh_nullptr_t libmesh_nullptr
The libMesh namespace provides an interface to certain functionality in the library.
This is the MeshBase class.
Definition: mesh_base.h:68
This class implements the default algebraic coupling in libMesh: elements couple to themselves...
virtual void delete_remote_elements() libmesh_override
GhostingFunctor subclasses with relatively long-lasting caches may want to delete the no-longer-relev...
DefaultCoupling()
Constructor.
virtual void redistribute() libmesh_override
GhostingFunctor subclasses with relatively long-lasting caches may want to redistribute those caches ...
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?
void set_dof_coupling(const CouplingMatrix *dof_coupling)
const CouplingMatrix * _dof_coupling
const PeriodicBoundaries * _periodic_bcs
void set_n_levels(unsigned int n_levels)
void set_periodic_boundaries(const PeriodicBoundaries *periodic_bcs)
virtual void mesh_reinit() libmesh_override
If we have periodic boundaries, then we&#39;ll need the mesh to have an updated point locator whenever we...
This class defines a coupling matrix.
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) libmesh_override
For the specified range of active elements, find the elements which will be coupled to them in the sp...