src/lagrangian/basic/IOPosition/IOPosition.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::IOPosition
  27
  28 Description
  29     Helper IO class to read and write particle positions
  30
  31 SourceFiles
  32     IOPosition.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef IOPosition_H
  37 #define IOPosition_H
  38
  39 #include "regIOobject.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                          Class IOPosition Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class ParticleType>
  51 class IOPosition
  52 :
  53     public regIOobject
  54 {
  55
  56     // Private data
  57
  58         //- Reference to the cloud
  59         const Cloud<ParticleType>& cloud_;
  60
  61
  62     // Private member functions
  63
  64         //- Read particle properties dictionary
  65         void readParticleProperties();
  66
  67         //- Write particle properties dictionary
  68         void writeParticleProperties() const;
  69
  70
  71 public:
  72
  73     // Static data
  74
  75         //- Runtime type name information. Use cloud type.
  76         virtual const word& type() const
  77         {
  78             return cloud_.type();
  79         }
  80
  81         //- Name of particle properties dictionary
  82         static word particlePropertiesName;
  83
  84
  85     // Constructors
  86
  87         //- Construct from cloud
  88         IOPosition(const Cloud<ParticleType>&);
  89
  90
  91     // Member functions
  92
  93         virtual void readData(Cloud<ParticleType>& c, bool checkClass);
  94
  95         virtual bool write() const;
  96
  97         virtual bool writeData(Ostream& os) const;
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #ifdef NoRepository
 108 #   include "IOPosition.C"
 109 #endif
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //