FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

fieldDictionary.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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::fieldDictionary
00026 
00027 Description
00028     Read field as dictionary (without mesh).
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef fieldDictionary_H
00033 #define fieldDictionary_H
00034 
00035 #include <OpenFOAM/regIOobject.H>
00036 #include <OpenFOAM/dictionary.H>
00037 
00038 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00039 
00040 namespace Foam
00041 {
00042 
00043 
00044 /*---------------------------------------------------------------------------*\
00045                            Class fieldDictionary Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 class fieldDictionary
00049 :
00050     public regIOobject,
00051     public dictionary
00052 {
00053     const word type_;
00054 
00055 public:
00056 
00057     // Redefine type name to be of the instantiated type
00058     virtual const word& type() const
00059     {
00060         return type_;
00061     }
00062 
00063 
00064     // Constructors
00065 
00066         //- Construct from ioobject and overloaded typename.
00067         explicit fieldDictionary(const IOobject& io, const word& type)
00068         :
00069             regIOobject(io),
00070             dictionary(readStream(type)),
00071             type_(type)
00072         {
00073             close();
00074         }
00075 
00076 
00077 
00078     // Member functions
00079 
00080         bool writeData(Ostream& os) const
00081         {
00082             static_cast<const dictionary&>(*this).write(os, false);
00083 
00084             return os.good();
00085         }
00086 };
00087 
00088 
00089 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00090 
00091 } // End namespace Foam
00092 
00093 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00094 
00095 #endif
00096 
00097 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines