OpenFOAM logo
Open Source CFD Toolkit

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-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     IOField
00027 
00028 Description
00029     A primitive field with IO.
00030 
00031 SourceFiles
00032     IOField.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef IOField_H
00037 #define IOField_H
00038 
00039 #include "regIOobject.H"
00040 #include "Field.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class IOField Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 template<class Type>
00052 class IOField
00053 :
00054     public regIOobject,
00055     public Field<Type>
00056 {
00057 
00058 public:
00059 
00060     TypeName("Field");
00061 
00062 
00063     // Constructors
00064 
00065         //- Construct from IOobject
00066         IOField
00067         (
00068             const IOobject&
00069         );
00070 
00071         //- Construct from components
00072         IOField
00073         (
00074             const IOobject&,
00075             const Field<Type>&
00076         );
00077 
00078         //- Construct from IOobject and size (does not set values)
00079         IOField
00080         (
00081             const IOobject&,
00082             const label size
00083         );
00084 
00085 
00086     // Member functions
00087 
00088         bool writeData(Ostream& os) const
00089         {
00090             return (os << static_cast<const Field<Type>&>(*this)).good();
00091         }
00092 
00093 
00094     // Member operators
00095 
00096         void operator=(const IOField<Type>& iof)
00097         {
00098             Field<Type>::operator=(iof);
00099         }
00100 
00101         void operator=(const Field<Type>& f)
00102         {
00103             Field<Type>::operator=(f);
00104         }
00105 };
00106 
00107 
00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00109 
00110 } // End namespace Foam
00111 
00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00113 
00114 #ifdef NoRepository
00115 #   include "IOField.C"
00116 #endif
00117 
00118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00119 
00120 #endif
00121 
00122 // ************************************************************************* //
For further information go to www.openfoam.org