areaFaMesh.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) 2016-2017 Wikki Ltd
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::areaMesh
28 
29 Description
30  Mesh data needed to do the Finite Area discretisation.
31 
32 Author
33  Zeljko Tukovic, FMENA
34  Hrvoje Jasak, Wikki Ltd.
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef areaFaMesh_H
39 #define areaFaMesh_H
40 
41 #include "GeoMesh.H"
42 #include "faMesh.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class areaMesh Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class areaMesh
54 :
55  public GeoMesh<faMesh>
56 {
57 
58 public:
59 
60  explicit areaMesh(const faMesh& mesh)
61  :
63  {}
64 
65  label size() const
66  {
67  return size(mesh_);
68  }
69 
70  static label size(const Mesh& mesh)
71  {
72  return mesh.nFaces();
73  }
74 
75  const areaVectorField& C()
76  {
77  return mesh_.areaCentres();
78  }
79 };
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace Foam
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #endif
89 
90 // ************************************************************************* //
Foam::areaMesh::size
label size() const
Definition: areaFaMesh.H:64
faMesh.H
Foam::GeoMesh< faMesh >::mesh_
const faMesh & mesh_
Reference to Mesh.
Definition: GeoMesh.H:56
Foam::areaMesh
Mesh data needed to do the Finite Area discretisation.
Definition: areaFaMesh.H:52
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::areaMesh::C
const areaVectorField & C()
Definition: areaFaMesh.H:74
Foam::GeoMesh
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:48
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::areaMesh::areaMesh
areaMesh(const faMesh &mesh)
Definition: areaFaMesh.H:59
Foam::areaMesh::size
static label size(const Mesh &mesh)
Definition: areaFaMesh.H:69
Foam::faMesh
Finite area mesh. Used for 2-D non-Euclidian finite area method.
Definition: faMesh.H:77
Foam::GeometricField
Generic GeometricField class.
Definition: areaFieldsFwd.H:53
GeoMesh.H
Foam::faMesh::areaCentres
const areaVectorField & areaCentres() const
Return face centres as areaVectorField.
Definition: faMesh.C:1058