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