src/OpenFOAM/meshes/GeoMesh/GeoMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::GeoMesh
  27
  28 Description
  29     Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef GeoMesh_H
  34 #define GeoMesh_H
  35
  36 #include "objectRegistry.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                            Class GeoMesh Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 template<class MESH>
  48 class GeoMesh
  49 {
  50
  51 protected:
  52
  53     // Protected data
  54
  55         //- Reference to Mesh
  56         const MESH& mesh_;
  57
  58
  59 public:
  60
  61     // Public typedefs
  62
  63         typedef MESH Mesh;
  64         typedef typename MESH::BoundaryMesh BoundaryMesh;
  65
  66
  67     // Constructors
  68
  69         //- Construct from MESH
  70         explicit GeoMesh(const MESH& mesh)
  71         :
  72             mesh_(mesh)
  73         {}
  74
  75
  76     // Member Functions
  77
  78         //- Return the object registry
  79         const objectRegistry& thisDb() const
  80         {
  81             return mesh_;
  82         }
  83
  84
  85     // Member Operators
  86
  87         //- Return reference to polyMesh
  88         const MESH& operator()() const
  89         {
  90             return mesh_;
  91         }
  92 };
  93
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //