libMesh
ghosting_functor.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_GHOSTING_FUNCTOR_H
21 #define LIBMESH_GHOSTING_FUNCTOR_H
22 
23 // Local Includes
24 #include "libmesh/libmesh_common.h"
25 #include "libmesh/id_types.h"
26 #include "libmesh/mesh_base.h"
27 #include "libmesh/reference_counted_object.h"
28 
29 // C++ Includes
30 #include <unordered_map>
31 
32 namespace libMesh
33 {
34 
35 // Forward Declarations
36 class CouplingMatrix;
37 class Elem;
38 
39 
122 class GhostingFunctor : public ReferenceCountedObject<GhostingFunctor>
123 {
124 public:
125 
130 
134  virtual ~GhostingFunctor() {}
135 
140  typedef std::unordered_map<const Elem*, const CouplingMatrix*> map_type;
141 
152  virtual void operator() (const MeshBase::const_element_iterator & range_begin,
153  const MeshBase::const_element_iterator & range_end,
155  map_type & coupled_elements) = 0;
156 
163  virtual void mesh_reinit () {};
164 
171  virtual void dofmap_reinit () {};
172 
183  virtual void redistribute () {};
184 
190  virtual void delete_remote_elements () {};
191 };
192 
193 } // namespace libMesh
194 
195 #endif // LIBMESH_GHOSTING_FUNCTOR_H
virtual void mesh_reinit()
GhostingFunctor subclasses which cache data will need to initialize that cache.
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
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)=0
For the specified range of active elements, what other elements currently living (whether local or gh...
uint8_t processor_id_type
Definition: id_types.h:99
virtual void redistribute()
GhostingFunctor subclasses with relatively long-lasting caches may want to redistribute those caches ...
GhostingFunctor()
Constructor.
The libMesh namespace provides an interface to certain functionality in the library.
virtual void dofmap_reinit()
For algebraic ghosting or coupling functors we also call dofmap_reinit() later, after dofs have been ...
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?
This class implements reference counting.
virtual ~GhostingFunctor()
Virtual destructor; this is an abstract base class.
virtual void delete_remote_elements()
GhostingFunctor subclasses with relatively long-lasting caches may want to delete the no-longer-relev...