src/OpenFOAM/meshes/MeshObject/MeshObject.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::MeshObject
  27
  28 Description
  29     Templated abstract base-class for dynamic mesh objects used to automate
  30     their allocation to the mesh database and the mesh-modifier event-loop.
  31
  32 SourceFiles
  33     MeshObject.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef MeshObject_H
  38 #define MeshObject_H
  39
  40 #include "regIOobject.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class MeshObject Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51
  52 template<class Mesh, class Type>
  53 class MeshObject
  54 :
  55     public regIOobject
  56 {
  57
  58 protected:
  59
  60         // Reference to Mesh
  61         const Mesh& mesh_;
  62
  63
  64 public:
  65
  66     // Constructors
  67
  68         explicit MeshObject(const Mesh& mesh);
  69
  70         static const Type& New(const Mesh& mesh);
  71
  72         template<class Data1>
  73         static const Type& New
  74         (
  75             const Mesh& mesh,
  76             const Data1& d
  77         );
  78
  79         template<class Data1, class Data2>
  80         static const Type& New
  81         (
  82             const Mesh& mesh,
  83             const Data1&,
  84             const Data2&
  85         );
  86
  87         template<class Data1, class Data2, class Data3>
  88         static const Type& New
  89         (
  90             const Mesh& mesh,
  91             const Data1&,
  92             const Data2&,
  93             const Data3&
  94         );
  95
  96         template<class Data1, class Data2, class Data3, class Data4>
  97         static const Type& New
  98         (
  99             const Mesh& mesh,
 100             const Data1&,
 101             const Data2&,
 102             const Data3&,
 103             const Data4&
 104         );
 105
 106
 107     // Destructors
 108
 109         virtual ~MeshObject();
 110
 111         static bool Delete(const Mesh& mesh);
 112
 113
 114     // Member Functions
 115
 116         const Mesh& mesh() const
 117         {
 118             return mesh_;
 119         }
 120
 121         virtual bool writeData(Foam::Ostream&) const
 122         {
 123             return true;
 124         }
 125 };
 126
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 } // End namespace Foam
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #ifdef NoRepository
 135 #   include "MeshObject.C"
 136 #endif
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 #endif
 141
 142 // ************************************************************************* //