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

IOField.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::IOField
00026 
00027 Description
00028     A primitive field of type <T> with automated input and output.
00029 
00030 SourceFiles
00031     IOField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef IOField_H
00036 #define IOField_H
00037 
00038 #include <OpenFOAM/regIOobject.H>
00039 #include <OpenFOAM/Field.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class IOField Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 template<class Type>
00051 class IOField
00052 :
00053     public regIOobject,
00054     public Field<Type>
00055 {
00056 
00057 public:
00058 
00059     TypeName("Field");
00060 
00061 
00062     // Constructors
00063 
00064         //- Construct from IOobject
00065         IOField(const IOobject&);
00066 
00067         //- Construct from IOobject and size (does not set values)
00068         IOField(const IOobject&, const label size);
00069 
00070         //- Construct from components
00071         IOField(const IOobject&, const Field<Type>&);
00072 
00073         //- Construct by transferring the Field contents
00074         IOField(const IOobject&, const Xfer<Field<Type> >&);
00075 
00076 
00077     // Destructor
00078 
00079         virtual ~IOField();
00080 
00081 
00082     // Member functions
00083 
00084         bool writeData(Ostream&) const;
00085 
00086 
00087     // Member operators
00088 
00089         void operator=(const IOField<Type>&);
00090 
00091         void operator=(const Field<Type>&);
00092 };
00093 
00094 
00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00096 
00097 } // End namespace Foam
00098 
00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00100 
00101 #ifdef NoRepository
00102 #   include <OpenFOAM/IOField.C>
00103 #endif
00104 
00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00106 
00107 #endif
00108 
00109 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines