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