src/lagrangian/intermediate/clouds/derived/basicKinematicCloud/basicKinematicCloud.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::basicKinematicCloud
  27
  28 Description
  29     Cloud class to introduce kinematic parcels
  30
  31 SourceFiles
  32     basicKinematicCloud.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef basicKinematicCloud_H
  37 #define basicKinematicCloud_H
  38
  39 #include "KinematicCloud.H"
  40 #include "basicKinematicParcel.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                       Class basicKinematicCloud Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class basicKinematicCloud
  52 :
  53     public KinematicCloud<basicKinematicParcel>
  54 {
  55     // Private member functions
  56
  57         //- Disallow default bitwise copy construct
  58         basicKinematicCloud(const basicKinematicCloud&);
  59
  60         //- Disallow default bitwise assignment
  61         void operator=(const basicKinematicCloud&);
  62
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("basicKinematicCloud");
  68
  69
  70     // Constructors
  71
  72         //- Construct from components
  73         basicKinematicCloud
  74         (
  75             const word& cloudName,
  76             const volScalarField& rho,
  77             const volVectorField& U,
  78             const volScalarField& mu,
  79             const dimensionedVector& g
  80         );
  81
  82
  83     //- Destructor
  84     ~basicKinematicCloud();
  85
  86
  87     // Member functions
  88
  89         //- Write fields
  90         virtual void writeFields() const;
  91 };
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace Foam
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 #endif
 100
 101 // ************************************************************************* //