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 | 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::volMesh
26 
27 Description
28  Mesh data needed to do the Finite Volume discretisation.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef volMesh_H
33 #define volMesh_H
34 
35 #include "GeoMesh.H"
36 #include "fvMesh.H"
37 #include "primitiveMesh.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class volMesh Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 class volMesh
49 :
50  public GeoMesh<fvMesh>
51 {
52 
53 public:
54 
55  // Constructors
56 
57  //- Construct from fvMesh
58  explicit volMesh(const fvMesh& mesh)
59  :
60  GeoMesh<fvMesh>(mesh)
61  {}
62 
63 
64  // Member Functions
65 
66  //- Return size
67  label size() const
68  {
69  return size(mesh_);
70  }
71 
72  //- Return size
73  static label size(const Mesh& mesh)
74  {
75  return mesh.nCells();
76  }
77 
78  //- Return cell centres
79  const volVectorField& C()
80  {
81  return mesh_.C();
82  }
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: volMesh.H:47
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
const fvMesh & mesh_
Reference to Mesh.
Definition: GeoMesh.H:54
volMesh(const fvMesh &mesh)
Construct from fvMesh.
Definition: volMesh.H:57
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
label nCells() const
dynamicFvMesh & mesh
const volVectorField & C()
Return cell centres.
Definition: volMesh.H:78
Namespace for OpenFOAM.
const volVectorField & C() const
Return cell centres as volVectorField.
label size() const
Return size.
Definition: volMesh.H:66
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:46