src/lagrangian/solidParticle/solidParticleCloud.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::solidParticleCloud
  27
  28 Description
  29     A Cloud of solid particles
  30
  31 SourceFiles
  32     solidParticleCloudI.H
  33     solidParticleCloud.C
  34     solidParticleCloudIO.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef solidParticleCloud_H
  39 #define solidParticleCloud_H
  40
  41 #include "Cloud.H"
  42 #include "solidParticle.H"
  43 #include "IOdictionary.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward declaration of classes
  51 class fvMesh;
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class solidParticleCloud Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class solidParticleCloud
  58 :
  59     public Cloud<solidParticle>
  60 {
  61     // Private data
  62
  63         const fvMesh& mesh_;
  64
  65         IOdictionary particleProperties_;
  66
  67         scalar rhop_;
  68         scalar e_;
  69         scalar mu_;
  70
  71
  72     // Private Member Functions
  73
  74         //- Disallow default bitwise copy construct
  75         solidParticleCloud(const solidParticleCloud&);
  76
  77         //- Disallow default bitwise assignment
  78         void operator=(const solidParticleCloud&);
  79
  80
  81 public:
  82
  83     // Constructors
  84
  85         //- Construct given mesh
  86         solidParticleCloud
  87         (
  88             const fvMesh&,
  89             const word& cloudName = "defaultCloud",
  90             bool readFields = true
  91         );
  92
  93
  94     // Member Functions
  95
  96         // Access
  97
  98             inline const fvMesh& mesh() const;
  99
 100             inline scalar rhop() const;
 101             inline scalar e() const;
 102             inline scalar mu() const;
 103
 104
 105         // Edit
 106
 107             //- Move the particles under the influence of the given
 108             //  gravitational acceleration
 109             void move(const dimensionedVector& g);
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #include "solidParticleCloudI.H"
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #endif
 124
 125 // ************************************************************************* //