src/lagrangian/basic/IOPosition/IOPosition.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 public:
  63
  64     // Static data
  65
  66         //- Runtime type name information. Use cloud type.
  67         virtual const word& type() const
  68         {
  69             return cloud_.type();
  70         }
  71
  72
  73     // Constructors
  74
  75         //- Construct from cloud
  76         IOPosition(const Cloud<ParticleType>&);
  77
  78
  79     // Member functions
  80
  81         virtual void readData(Cloud<ParticleType>& c, bool checkClass);
  82
  83         virtual bool write() const;
  84
  85         virtual bool writeData(Ostream& os) const;
  86 };
  87
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 } // End namespace Foam
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 #ifdef NoRepository
  96 #   include "IOPosition.C"
  97 #endif
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //