src/lagrangian/basic/passiveParticle/passiveParticle.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::passiveParticle
  26
  27 Description
  28
  29 SourceFiles
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef passiveParticle_H
  34 #define passiveParticle_H
  35
  36 #include "Particle.H"
  37 #include "IOstream.H"
  38 #include "autoPtr.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                       Class passiveParticle Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class passiveParticle
  50 :
  51     public Particle<passiveParticle>
  52 {
  53
  54 public:
  55
  56     // Constructors
  57
  58         //- Construct from components
  59         passiveParticle
  60         (
  61             const Cloud<passiveParticle>& c,
  62             const vector& position,
  63             const label celli
  64         )
  65         :
  66             Particle<passiveParticle>(c, position, celli)
  67         {}
  68
  69         //- Construct from Istream
  70         passiveParticle
  71         (
  72             const Cloud<passiveParticle>& c,
  73             Istream& is,
  74             bool readFields = true
  75         )
  76         :
  77             Particle<passiveParticle>(c, is, readFields)
  78         {}
  79
  80         //- Construct as copy
  81         passiveParticle(const passiveParticle& p)
  82         :
  83             Particle<passiveParticle>(p)
  84         {}
  85
  86         //- Construct and return a clone
  87         autoPtr<passiveParticle> clone() const
  88         {
  89             return autoPtr<passiveParticle>(new passiveParticle(*this));
  90         }
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //