src/finiteVolume/volMesh/volMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::volMesh
  27
  28 Description
  29     Mesh data needed to do the Finite Volume discretisation.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef volMesh_H
  34 #define volMesh_H
  35
  36 #include "GeoMesh.H"
  37 #include "fvMesh.H"
  38 #include "primitiveMesh.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class volMesh Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class volMesh
  50 :
  51     public GeoMesh<fvMesh>
  52 {
  53
  54 public:
  55
  56     // Constructors
  57
  58         //- Construct from fvMesh
  59         explicit volMesh(const fvMesh& mesh)
  60         :
  61             GeoMesh<fvMesh>(mesh)
  62         {}
  63
  64
  65     // Member Functions
  66
  67         //- Return size
  68         label size() const
  69         {
  70             return size(mesh_);
  71         }
  72
  73         //- Return size
  74         static label size(const Mesh& mesh)
  75         {
  76             return mesh.nCells();
  77         }
  78
  79         //- Return cell centres
  80         const volVectorField& C()
  81         {
  82             return mesh_.C();
  83         }
  84 };
  85
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 } // End namespace Foam
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 #endif
  94
  95 // ************************************************************************* //