src/lagrangian/solidParticle/solidParticleCloud.H

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