src/lagrangian/basic/IOPosition/IOPosition.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::IOPosition
  26
  27 Description
  28     Helper IO class to read and write particle positions
  29
  30 SourceFiles
  31     IOPosition.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef IOPosition_H
  36 #define IOPosition_H
  37
  38 #include "regIOobject.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                          Class IOPosition Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class ParticleType>
  50 class IOPosition
  51 :
  52     public regIOobject
  53 {
  54
  55     // Private data
  56
  57         //- Reference to the cloud
  58         const Cloud<ParticleType>& cloud_;
  59
  60
  61 public:
  62
  63     // Static data
  64
  65         //- Runtime type name information. Use cloud type.
  66         virtual const word& type() const
  67         {
  68             return cloud_.type();
  69         }
  70
  71
  72     // Constructors
  73
  74         //- Construct from cloud
  75         IOPosition(const Cloud<ParticleType>&);
  76
  77
  78     // Member functions
  79
  80         virtual void readData(Cloud<ParticleType>& c, bool checkClass);
  81
  82         virtual bool write() const;
  83
  84         virtual bool writeData(Ostream& os) const;
  85 };
  86
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 } // End namespace Foam
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #ifdef NoRepository
  95 #   include "IOPosition.C"
  96 #endif
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //