src/lagrangian/basic/passiveParticle/passiveParticle.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::passiveParticle
  27
  28 Description
  29
  30 SourceFiles
  31     passiveParticleI.H
  32     passiveParticle.C
  33     passiveParticleIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef passiveParticle_H
  38 #define passiveParticle_H
  39
  40 #include "Particle.H"
  41 #include "IOstream.H"
  42 #include "autoPtr.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class passiveParticle Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class passiveParticle
  54 :
  55     public Particle<passiveParticle>
  56 {
  57
  58 public:
  59
  60     // Constructors
  61
  62         //- Construct from components
  63         passiveParticle
  64         (
  65             const Cloud<passiveParticle>& c,
  66             const vector& position,
  67             const label celli
  68         )
  69         :
  70             Particle<passiveParticle>(c, position, celli)
  71         {}
  72
  73         //- Construct from Istream
  74         passiveParticle
  75         (
  76             const Cloud<passiveParticle>& c,
  77             Istream& is,
  78             bool readFields = true
  79         )
  80         :
  81             Particle<passiveParticle>(c, is, readFields)
  82         {}
  83
  84         //- Construct as copy
  85         passiveParticle(const passiveParticle& p)
  86         :
  87             Particle<passiveParticle>(p)
  88         {}
  89
  90         //- Construct and return a clone
  91         autoPtr<passiveParticle> clone() const
  92         {
  93             return autoPtr<passiveParticle>(new passiveParticle(*this));
  94         }
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #endif
 105
 106 // ************************************************************************* //