volMesh.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::volMesh
28 
29 Description
30  Mesh data needed to do the Finite Volume discretisation.
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef volMesh_H
35 #define volMesh_H
36 
37 #include "GeoMesh.H"
38 #include "fvMesh.H"
39 #include "primitiveMesh.H"
40 #include <type_traits>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class volMesh Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class volMesh
52 :
53  public GeoMesh<fvMesh>
54 {
55 public:
56 
57  // Constructors
58 
59  //- Construct from fvMesh
60  explicit volMesh(const fvMesh& mesh)
61  :
63  {}
64 
65 
66  // Member Functions
67 
68  //- Return size
69  static label size(const Mesh& mesh)
70  {
71  return mesh.nCells();
72  }
73 
74  //- Return size
75  label size() const
76  {
77  return size(mesh_);
78  }
79 
80  //- Return cell centres
81  const volVectorField& C()
82  {
83  return mesh_.C();
84  }
85 };
86 
87 
88 /*---------------------------------------------------------------------------*\
89  Class isVolMesh Declaration
90 \*---------------------------------------------------------------------------*/
91 
92 //- Template argument for type volMesh.
93 template<class> struct isVolMesh : std::false_type {};
94 
95 template<> struct isVolMesh<volMesh> : std::true_type {};
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
Foam::volMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: volMesh.H:50
primitiveMesh.H
Foam::GeoMesh< fvMesh >::mesh_
const fvMesh & mesh_
Reference to Mesh.
Definition: GeoMesh.H:56
Foam::volMesh::C
const volVectorField & C()
Return cell centres.
Definition: volMesh.H:80
Foam::fvMesh::C
const volVectorField & C() const
Return cell centres as volVectorField.
Definition: fvMeshGeometry.C:341
Foam::volMesh::volMesh
volMesh(const fvMesh &mesh)
Construct from fvMesh.
Definition: volMesh.H:59
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::GeoMesh
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:48
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:84
fvMesh.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::volMesh::size
label size() const
Return size.
Definition: volMesh.H:74
Foam::isVolMesh
Template argument for type volMesh.
Definition: volMesh.H:92
Foam::GeometricField< vector, fvPatchField, volMesh >
GeoMesh.H
Foam::volMesh::size
static label size(const Mesh &mesh)
Return size.
Definition: volMesh.H:68