GeoMesh.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::GeoMesh
26 
27 Description
28  Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef GeoMesh_H
33 #define GeoMesh_H
34 
35 #include "objectRegistry.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class GeoMesh Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class MESH>
47 class GeoMesh
48 {
49 
50 protected:
51 
52  // Protected data
53 
54  //- Reference to Mesh
55  const MESH& mesh_;
56 
57 
58 public:
59 
60  // Public typedefs
61 
62  typedef MESH Mesh;
63  typedef typename MESH::BoundaryMesh BoundaryMesh;
64 
65 
66  // Constructors
67 
68  //- Construct from MESH
69  explicit GeoMesh(const MESH& mesh)
70  :
71  mesh_(mesh)
72  {}
73 
74 
75  // Member Functions
76 
77  //- Return the object registry
78  const objectRegistry& thisDb() const
79  {
80  return mesh_;
81  }
82 
83 
84  // Member Operators
85 
86  //- Return reference to polyMesh
87  const MESH& operator()() const
88  {
89  return mesh_;
90  }
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
const MESH & mesh_
Reference to Mesh.
Definition: GeoMesh.H:54
const objectRegistry & thisDb() const
Return the object registry.
Definition: GeoMesh.H:77
MESH::BoundaryMesh BoundaryMesh
Definition: GeoMesh.H:62
dynamicFvMesh & mesh
const MESH & operator()() const
Return reference to polyMesh.
Definition: GeoMesh.H:86
Namespace for OpenFOAM.
MESH Mesh
Definition: GeoMesh.H:61
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:46
Registry of regIOobjects.
GeoMesh(const MESH &mesh)
Construct from MESH.
Definition: GeoMesh.H:68