src/lagrangian/intermediate/particleForces/particleForces.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::particleForces
  27
  28 Description
  29     Provides a mechanism to calculate particle forces
  30     Note: forces are force per unit mass (accelerations)
  31
  32 SourceFiles
  33     particleForces.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef particleForces_H
  38 #define particleForces_H
  39
  40 #include "dictionary.H"
  41 #include "Switch.H"
  42 #include "vector.H"
  43 #include "volFieldsFwd.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward class declarations
  51 class fvMesh;
  52
  53 /*---------------------------------------------------------------------------*\
  54                       Class particleForces Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class particleForces
  58 {
  59     // Private data
  60
  61         //- Reference to the mesh database
  62         const fvMesh& mesh_;
  63
  64         //- The particleForces dictionary
  65         const dictionary& dict_;
  66
  67         //- Gravity
  68         const vector g_;
  69
  70         //- Velocity gradient field
  71         const volTensorField* gradUPtr_;
  72
  73
  74         // Forces to include in particle motion evaluation
  75
  76             //- Gravity
  77             Switch gravity_;
  78
  79             //- Virtual mass
  80             Switch virtualMass_;
  81
  82             //- Virtual mass force coefficient
  83             scalar Cvm_;
  84
  85             //- Pressure gradient
  86             Switch pressureGradient_;
  87
  88
  89         // Additional info
  90
  91             //- Name of velucity field - default = "U"
  92             const word UName_;
  93
  94
  95 public:
  96
  97     // Constructors
  98
  99         //- Construct from mesh, dictionary and gravity
 100         particleForces
 101         (
 102             const fvMesh& mesh,
 103             const dictionary& dict,
 104             const vector& g
 105         );
 106
 107         //- Construct copy
 108         particleForces(const particleForces& f);
 109
 110
 111     //- Destructor
 112     ~particleForces();
 113
 114
 115     // Member Functions
 116
 117         // Access
 118
 119             //- Return the particleForces dictionary
 120             const dictionary& dict() const;
 121
 122             //- Return the gravity vector
 123             const vector& g() const;
 124
 125             //- Return gravity force activate switch
 126             Switch gravity() const;
 127
 128             //- Return virtual mass force activate switch
 129             Switch virtualMass() const;
 130
 131             //- Return virtual mass force coefficient
 132             Switch Cvm() const;
 133
 134             //- Return pressure gradient force activate switch
 135             Switch pressureGradient() const;
 136
 137             //- Return name of velocity field
 138             const word& UName() const;
 139
 140
 141        // Evaluation
 142
 143             //- Cache carrier fields
 144             void cacheFields(const bool store);
 145
 146             //- Calculate action/reaction forces between carrier and particles
 147             vector calcCoupled
 148             (
 149                 const label cellI,
 150                 const scalar dt,
 151                 const scalar rhoc,
 152                 const scalar rho,
 153                 const vector& Uc,
 154                 const vector& U
 155             ) const;
 156
 157             //- Calculate external forces applied to the particles
 158             vector calcNonCoupled
 159             (
 160                 const label cellI,
 161                 const scalar dt,
 162                 const scalar rhoc,
 163                 const scalar rho,
 164                 const vector& Uc,
 165                 const vector& U
 166             ) const;
 167 };
 168
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 } // End namespace Foam
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 #endif
 177
 178 // ************************************************************************* //