src/finiteVolume/surfaceMesh/surfaceMesh.H

   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::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 #include "primitiveMesh.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Class surfaceMesh Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class surfaceMesh
  49 :
  50     public GeoMesh<fvMesh>
  51 {
  52
  53 public:
  54
  55     explicit surfaceMesh(const fvMesh& mesh)
  56     :
  57         GeoMesh<fvMesh>(mesh)
  58     {}
  59
  60     label size() const
  61     {
  62         return size(mesh_);
  63     }
  64
  65     static label size(const Mesh& mesh)
  66     {
  67         return mesh.nInternalFaces();
  68     }
  69
  70     const surfaceVectorField& C()
  71     {
  72         return mesh_.Cf();
  73     }
  74 };
  75
  76
  77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  78
  79 } // End namespace Foam
  80
  81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  82
  83 #endif
  84
  85 // ************************************************************************* //