src/lagrangian/intermediate/particleForces/particleForces.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-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 \*---------------------------------------------------------------------------*/
  26
  27 #include "particleForces.H"
  28 #include "fvMesh.H"
  29 #include "volFields.H"
  30 #include "fvcGrad.H"
  31
  32 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  33
  34 Foam::particleForces::particleForces
  35 (
  36     const fvMesh& mesh,
  37     const dictionary& dict,
  38     const vector& g
  39 )
  40 :
  41     mesh_(mesh),
  42     dict_(dict.subDict("particleForces")),
  43     g_(g),
  44     gradUPtr_(NULL),
  45     gravity_(dict_.lookup("gravity")),
  46     virtualMass_(dict_.lookup("virtualMass")),
  47     Cvm_(0.0),
  48     pressureGradient_(dict_.lookup("pressureGradient")),
  49     UName_(dict_.lookupOrDefault<word>("U", "U"))
  50 {
  51     if (virtualMass_)
  52     {
  53         dict_.lookup("Cvm") >> Cvm_;
  54     }
  55 }
  56
  57
  58 Foam::particleForces::particleForces(const particleForces& f)
  59 :
  60     mesh_(f.mesh_),
  61     dict_(f.dict_),
  62     g_(f.g_),
  63     gradUPtr_(f.gradUPtr_),
  64     gravity_(f.gravity_),
  65     virtualMass_(f.virtualMass_),
  66     Cvm_(f.Cvm_),
  67     pressureGradient_(f.pressureGradient_),
  68     UName_(f.UName_)
  69 {}
  70
  71
  72 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  73
  74 Foam::particleForces::~particleForces()
  75 {
  76     cacheFields(false);
  77 }
  78
  79
  80 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  81
  82 const Foam::dictionary& Foam::particleForces::dict() const
  83 {
  84     return dict_;
  85 }
  86
  87
  88 const Foam::vector& Foam::particleForces::g() const
  89 {
  90     return g_;
  91 }
  92
  93
  94 Foam::Switch Foam::particleForces::gravity() const
  95 {
  96     return gravity_;
  97 }
  98
  99
 100 Foam::Switch Foam::particleForces::virtualMass() const
 101 {
 102     return virtualMass_;
 103 }
 104
 105
 106 Foam::Switch Foam::particleForces::pressureGradient() const
 107 {
 108     return pressureGradient_;
 109 }
 110
 111
 112 const Foam::word& Foam::particleForces::UName() const
 113 {
 114     return UName_;
 115 }
 116
 117
 118 void Foam::particleForces::cacheFields(const bool store)
 119 {
 120     if (store && pressureGradient_)
 121     {
 122         const volVectorField U = mesh_.lookupObject<volVectorField>(UName_);
 123         gradUPtr_ = fvc::grad(U).ptr();
 124     }
 125     else
 126     {
 127         if (gradUPtr_)
 128         {
 129             delete gradUPtr_;
 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