libMesh
periodic_boundary.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 #ifndef LIBMESH_PERIODIC_BOUNDARY_H
19 #define LIBMESH_PERIODIC_BOUNDARY_H
20 
21 // Local Includes
22 #include "libmesh/libmesh_config.h"
23 
24 #ifdef LIBMESH_ENABLE_PERIODIC
25 
26 // Local Includes
27 #include "libmesh/periodic_boundary_base.h"
28 #include "libmesh/vector_value.h" // RealVectorValue
29 
30 namespace libMesh
31 {
32 
33 // Forward Declarations
34 class Elem;
35 class MeshBase;
36 
45 {
46 public:
51 
55  virtual ~PeriodicBoundary() {}
56 
61 
65  PeriodicBoundary(const RealVectorValue & vector);
66 
72  virtual Point get_corresponding_pos(const Point & pt) const libmesh_override;
73 
79  virtual UniquePtr<PeriodicBoundaryBase> clone(TransformationType t = FORWARD) const libmesh_override;
80 
81 protected:
82  // One of these days we'll support rotated boundaries
83  // RealTensor rotation_matrix;
84 
85  // The vector which is added to points in myboundary
86  // to produce corresponding points in pairedboundary
88 };
89 
90 } // namespace libmesh
91 
92 #endif // LIBMESH_ENABLE_PERIODIC
93 
94 #endif // LIBMESH_PERIODIC_BOUNDARY_H
virtual ~PeriodicBoundary()
Destructor.
The libMesh namespace provides an interface to certain functionality in the library.
The definition of a periodic boundary.
std::unique_ptr< T > UniquePtr
Definition: auto_ptr.h:46
virtual UniquePtr< PeriodicBoundaryBase > clone(TransformationType t=FORWARD) const libmesh_override
If we want the DofMap to be able to make copies of references and store them in the underlying map...
RealVectorValue translation_vector
virtual Point get_corresponding_pos(const Point &pt) const libmesh_override
This function should be overridden by derived classes to define how one finds corresponding nodes on ...
The base class for defining periodic boundaries.
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition: point.h:38