src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/PressureGradient/PressureGradientForce.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::PressureGradientForce
  26
  27 Description
  28     Calculates particle pressure gradient force
  29
  30 SourceFiles
  31     PressureGradientForceI.H
  32     PressureGradientForce.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef PressureGradientForce_H
  37 #define PressureGradientForce_H
  38
  39 #include "ParticleForce.H"
  40 #include "volFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                     Class PressureGradientForce Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class CloudType>
  52 class PressureGradientForce
  53 :
  54     public ParticleForce<CloudType>
  55 {
  56     // Private data
  57
  58         //- Name of velocity field
  59         const word UName_;
  60
  61         //- Velocity gradient field
  62         const volTensorField* gradUPtr_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("pressureGradient");
  69
  70
  71     // Constructors
  72
  73         //- Construct from mesh
  74         PressureGradientForce
  75         (
  76             CloudType& owner,
  77             const fvMesh& mesh,
  78             const dictionary& dict
  79         );
  80
  81         //- Construct copy
  82         PressureGradientForce(const PressureGradientForce& pgf);
  83
  84         //- Construct and return a clone
  85         virtual autoPtr<ParticleForce<CloudType> > clone() const
  86         {
  87             return autoPtr<ParticleForce<CloudType> >
  88             (
  89                 new PressureGradientForce<CloudType>(*this)
  90             );
  91         }
  92
  93
  94     //- Destructor
  95     virtual ~PressureGradientForce();
  96
  97
  98     // Member Functions
  99
 100         // Access
 101
 102             //- Return const access to the velocity gradient field
 103             inline const volTensorField& gradU() const;
 104
 105
 106         // Evaluation
 107
 108             //- Cache fields
 109             virtual void cacheFields(const bool store);
 110
 111             //- Calculate the non-coupled force
 112             virtual forceSuSp calcCoupled
 113             (
 114                 const typename CloudType::parcelType& p,
 115                 const scalar dt,
 116                 const scalar mass,
 117                 const scalar Re,
 118                 const scalar muc
 119             ) const;
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace Foam
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #include "PressureGradientForceI.H"
 130
 131 #ifdef NoRepository
 132     #include "PressureGradientForce.C"
 133 #endif
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #endif
 138
 139 // ************************************************************************* //