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