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