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

IOPosition.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::IOPosition
00026 
00027 Description
00028     Helper IO class to read and write particle positions
00029 
00030 SourceFiles
00031     IOPosition.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef IOPosition_H
00036 #define IOPosition_H
00037 
00038 #include <OpenFOAM/regIOobject.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                          Class IOPosition Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class ParticleType>
00050 class IOPosition
00051 :
00052     public regIOobject
00053 {
00054 
00055     // Private data
00056 
00057         //- Reference to the cloud
00058         const Cloud<ParticleType>& cloud_;
00059 
00060 
00061 public:
00062 
00063     // Static data
00064 
00065         //- Runtime type name information. Use cloud type.
00066         virtual const word& type() const
00067         {
00068             return cloud_.type();
00069         }
00070 
00071 
00072     // Constructors
00073 
00074         //- Construct from cloud
00075         IOPosition(const Cloud<ParticleType>&);
00076 
00077 
00078     // Member functions
00079 
00080         virtual void readData(Cloud<ParticleType>& c, bool checkClass);
00081 
00082         virtual bool write() const;
00083 
00084         virtual bool writeData(Ostream& os) const;
00085 };
00086 
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 } // End namespace Foam
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 #ifdef NoRepository
00095 #   include <lagrangian/IOPosition.C>
00096 #endif
00097 
00098 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00099 
00100 #endif
00101 
00102 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines