volMesh.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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::volMesh
26 
27 Description
28  Mesh data needed to do the Finite Volume discretisation.
29 
30 Class
31  Foam::isVolMesh
32 
33 Description
34  Supports static assertion that a template argument is of type volMesh.
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef volMesh_H
39 #define volMesh_H
40 
41 #include "GeoMesh.H"
42 #include "fvMesh.H"
43 #include "primitiveMesh.H"
44 #include <type_traits>
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class volMesh Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class volMesh
56 :
57  public GeoMesh<fvMesh>
58 {
59 
60 public:
61 
62  // Constructors
63 
64  //- Construct from fvMesh
65  explicit volMesh(const fvMesh& mesh)
66  :
67  GeoMesh<fvMesh>(mesh)
68  {}
69 
70 
71  // Member Functions
72 
73  //- Return size
74  label size() const
75  {
76  return size(mesh_);
77  }
78 
79  //- Return size
80  static label size(const Mesh& mesh)
81  {
82  return mesh.nCells();
83  }
84 
85  //- Return cell centres
86  const volVectorField& C()
87  {
88  return mesh_.C();
89  }
90 };
91 
92 
93 /*---------------------------------------------------------------------------*\
94  Class isVolMesh Declaration
95 \*---------------------------------------------------------------------------*/
96 
97 template<class T>
98 class isVolMesh
99 :
100  public std::false_type
101 {};
102 
104 template<>
105 class isVolMesh<volMesh>
106 :
107  public std::true_type
108 {};
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
volMesh(const fvMesh &mesh)
Construct from fvMesh.
Definition: volMesh.H:63
label nCells() const
Mesh data needed to do the Finite Volume discretisation.
Definition: volMesh.H:53
dynamicFvMesh & mesh
Supports static assertion that a template argument is of type volMesh.
Definition: volMesh.H:96
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
label size() const
Return size.
Definition: volMesh.H:72
const volVectorField & C() const
Return cell centres as volVectorField.
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:46
const fvMesh & mesh_
Reference to Mesh.
Definition: GeoMesh.H:54
const volVectorField & C()
Return cell centres.
Definition: volMesh.H:84
Namespace for OpenFOAM.