OpenFOAM logo
Open Source CFD Toolkit

MeshObject.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     MeshObject
00027 
00028 Description
00029     Templated abstract base-class for dynamic mesh objects used to automate
00030     their allocation to the mesh database and the mesh-modifier event-loop.
00031 
00032 SourceFiles
00033     MeshObject.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef MeshObject_H
00038 #define MeshObject_H
00039 
00040 #include "regIOobject.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 class fvMesh;
00048 
00049 /*---------------------------------------------------------------------------*\
00050                            Class MeshObject Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 
00054 template<class Type>
00055 class MeshObject
00056 :
00057     public regIOobject
00058 {
00059 
00060 protected:
00061 
00062         // Reference to fvMesh
00063         const fvMesh& mesh_;
00064 
00065 
00066 public:
00067 
00068     // Constructors
00069 
00070         explicit MeshObject(const fvMesh& mesh);
00071 
00072         static const Type& New(const fvMesh& mesh);
00073 
00074 
00075     // Member Functions
00076 
00077         virtual bool writeData(Foam::Ostream&) const
00078         {
00079             return true;
00080         }
00081 };
00082 
00083 
00084 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00085 
00086 } // End namespace Foam
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 #ifdef NoRepository
00091 #   include "MeshObject.C"
00092 #endif
00093 
00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00095 
00096 #endif
00097 
00098 // ************************************************************************* //
For further information go to www.openfoam.org