src/lagrangian/intermediate/particleForces/particleForces.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "particleForces.H"
  27 #include "fvMesh.H"
  28 #include "volFields.H"
  29 #include "fvcGrad.H"
  30
  31 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  32
  33 Foam::particleForces::particleForces
  34 (
  35     const fvMesh& mesh,
  36     const dictionary& dict,
  37     const vector& g
  38 )
  39 :
  40     mesh_(mesh),
  41     dict_(dict.subDict("particleForces")),
  42     g_(g),
  43     gradUPtr_(NULL),
  44     gravity_(dict_.lookup("gravity")),
  45     virtualMass_(dict_.lookup("virtualMass")),
  46     Cvm_(0.0),
  47     pressureGradient_(dict_.lookup("pressureGradient")),
  48     UName_(dict_.lookupOrDefault<word>("U", "U"))
  49 {
  50     if (virtualMass_)
  51     {
  52         dict_.lookup("Cvm") >> Cvm_;
  53     }
  54 }
  55
  56
  57 Foam::particleForces::particleForces(const particleForces& f)
  58 :
  59     mesh_(f.mesh_),
  60     dict_(f.dict_),
  61     g_(f.g_),
  62     gradUPtr_(f.gradUPtr_),
  63     gravity_(f.gravity_),
  64     virtualMass_(f.virtualMass_),
  65     Cvm_(f.Cvm_),
  66     pressureGradient_(f.pressureGradient_),
  67     UName_(f.UName_)
  68 {}
  69
  70
  71 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  72
  73 Foam::particleForces::~particleForces()
  74 {
  75     cacheFields(false);
  76 }
  77
  78
  79 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  80
  81 const Foam::dictionary& Foam::particleForces::dict() const
  82 {
  83     return dict_;
  84 }
  85
  86
  87 const Foam::vector& Foam::particleForces::g() const
  88 {
  89     return g_;
  90 }
  91
  92
  93 Foam::Switch Foam::particleForces::gravity() const
  94 {
  95     return gravity_;
  96 }
  97
  98
  99 Foam::Switch Foam::particleForces::virtualMass() const
 100 {
 101     return virtualMass_;
 102 }
 103
 104
 105 Foam::Switch Foam::particleForces::pressureGradient() const
 106 {
 107     return pressureGradient_;
 108 }
 109
 110
 111 const Foam::word& Foam::particleForces::UName() const
 112 {
 113     return UName_;
 114 }
 115
 116
 117 void Foam::particleForces::cacheFields(const bool store)
 118 {
 119     if (store && pressureGradient_)
 120     {
 121         const volVectorField U = mesh_.lookupObject<volVectorField>(UName_);
 122         gradUPtr_ = fvc::grad(U).ptr();
 123     }
 124     else
 125     {
 126         if (gradUPtr_)
 127         {
 128             delete gradUPtr_;
 129             gradUPtr_ = NULL;
 130         }
 131     }
 132 }
 133
 134
 135 Foam::vector Foam::particleForces::calcCoupled
 136 (
 137     const label cellI,
 138     const scalar dt,
 139     const scalar rhoc,
 140     const scalar rho,
 141     const vector& Uc,
 142     const vector& U
 143 ) const
 144 {
 145     vector Ftot = vector::zero;
 146
 147     // Virtual mass force
 148     if (virtualMass_)
 149     {
 150         notImplemented
 151         (
 152             "Foam::particleForces::calcCoupled(...) - virtual mass force"
 153         );
 154 //        Ftot += Cvm_*rhoc/rho*d(Uc - U)/dt;
 155     }
 156
 157     // Pressure gradient force
 158     if (pressureGradient_)
 159     {
 160         const volTensorField& gradU = *gradUPtr_;
 161         Ftot += rhoc/rho*(U & gradU[cellI]);
 162     }
 163
 164     return Ftot;
 165 }
 166
 167
 168 Foam::vector Foam::particleForces::calcNonCoupled
 169 (
 170     const label cellI,
 171     const scalar dt,
 172     const scalar rhoc,
 173     const scalar rho,
 174     const vector& Uc,
 175     const vector& U
 176 ) const
 177 {
 178     vector Ftot = vector::zero;
 179
 180     // Gravity force
 181     if (gravity_)
 182     {
 183         Ftot += g_*(1.0 - rhoc/rho);
 184     }
 185
 186     return Ftot;
 187 }
 188
 189
 190 // ************************************************************************* //
 191