surfaceMesh.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-2022 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::surfaceMesh
26 
27 Description
28  Mesh data needed to do the Finite Volume discretisation.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef surfaceMesh_H
33 #define surfaceMesh_H
34 
35 #include "GeoMesh.H"
36 #include "fvMesh.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class surfaceMesh Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class surfaceMesh
48 :
49  public GeoMesh<fvMesh>
50 {
51 
52 public:
53 
54  explicit surfaceMesh(const fvMesh& mesh)
55  :
56  GeoMesh<fvMesh>(mesh)
57  {}
58 
59  label size() const
60  {
61  return size(mesh_);
62  }
63 
64  static label size(const Mesh& mesh)
65  {
66  return mesh.nInternalFaces();
67  }
68 
69  const surfaceVectorField& C()
70  {
71  return mesh_.Cf();
72  }
73 };
74 
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 } // End namespace Foam
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 #endif
83 
84 // ************************************************************************* //
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.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:101
const surfaceVectorField & Cf() const
Return face centres.
label nInternalFaces() const
Mesh data needed to do the Finite Volume discretisation.
Definition: surfaceMesh.H:49
const surfaceVectorField & C()
Definition: surfaceMesh.H:68
label size() const
Definition: surfaceMesh.H:58
surfaceMesh(const fvMesh &mesh)
Definition: surfaceMesh.H:53
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