src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Gravity/GravityForce.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011-2011 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
  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::GravityForce
  26
  27 Description
  28     Calculates particle gravity force
  29
  30 SourceFiles
  31     GravityForceI.H
  32     GravityForce.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef GravityForce_H
  37 #define GravityForce_H
  38
  39 #include "ParticleForce.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 class fvMesh;
  47
  48 /*---------------------------------------------------------------------------*\
  49                        Class GravityForce Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template<class CloudType>
  53 class GravityForce
  54 :
  55     public ParticleForce<CloudType>
  56 {
  57     // Private data
  58
  59         //- Reference to the acceleration due to gravity
  60         const vector& g_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("gravity");
  67
  68
  69     // Constructors
  70
  71         //- Construct from mesh
  72         GravityForce
  73         (
  74             CloudType& owner,
  75             const fvMesh& mesh,
  76             const dictionary& dict
  77         );
  78
  79         //- Construct copy
  80         GravityForce(const GravityForce& gf);
  81
  82         //- Construct and return a clone
  83         virtual autoPtr<ParticleForce<CloudType> > clone() const
  84         {
  85             return autoPtr<ParticleForce<CloudType> >
  86             (
  87                 new GravityForce<CloudType>(*this)
  88             );
  89         }
  90
  91
  92     //- Destructor
  93     virtual ~GravityForce();
  94
  95
  96     // Member Functions
  97
  98         // Access
  99
 100             //- Return the acceleration due to gravity
 101             inline const vector& g() const;
 102
 103
 104         // Evaluation
 105
 106             //- Calculate the non-coupled force
 107             virtual forceSuSp calcNonCoupled
 108             (
 109                 const typename CloudType::parcelType& p,
 110                 const scalar dt,
 111                 const scalar mass,
 112                 const scalar Re,
 113                 const scalar muc
 114             ) const;
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #include "GravityForceI.H"
 125
 126 #ifdef NoRepository
 127     #include "GravityForce.C"
 128 #endif
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #endif
 133
 134 // ************************************************************************* //