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-2023 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  // Public typedefs
63 
64  //- Field source type
65  template<class Type>
67 
68 
69  // Constructors
70 
71  //- Construct from fvMesh
72  explicit volMesh(const fvMesh& mesh)
73  :
74  GeoMesh<fvMesh>(mesh)
75  {}
76 
77 
78  // Member Functions
79 
80  //- Return size
81  label size() const
82  {
83  return size(mesh_);
84  }
85 
86  //- Return size
87  static label size(const Mesh& mesh)
88  {
89  return mesh.nCells();
90  }
91 
92  //- Return cell centres
93  const volVectorField& C()
94  {
95  return mesh_.C();
96  }
97 };
98 
99 
100 /*---------------------------------------------------------------------------*\
101  Class isVolMesh Declaration
102 \*---------------------------------------------------------------------------*/
103 
104 template<class T>
105 class isVolMesh
106 :
107  public std::false_type
108 {};
109 
110 
111 template<>
112 class isVolMesh<volMesh>
113 :
114  public std::true_type
115 {};
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:47
const fvMesh & mesh_
Reference to Mesh.
Definition: GeoMesh.H:54
Generic GeometricField class.
Base class for finite-volume field sources.
Definition: fvFieldSource.H:62
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
const volVectorField & C() const
Return cell centres.
Supports static assertion that a template argument is of type volMesh.
Definition: volMesh.H:106
label nCells() const
Mesh data needed to do the Finite Volume discretisation.
Definition: volMesh.H:56
const volVectorField & C()
Return cell centres.
Definition: volMesh.H:91
label size() const
Return size.
Definition: volMesh.H:79
volMesh(const fvMesh &mesh)
Construct from fvMesh.
Definition: volMesh.H:70
Namespace for OpenFOAM.
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