src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForce.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::ParticleForce
  26
  27 Description
  28     Abstract base class for particle forces
  29
  30 SourceFiles
  31     ParticleForceI.H
  32     ParticleForce.C
  33     ParticleForceNew.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef ParticleForce_H
  38 #define ParticleForce_H
  39
  40 #include "dictionary.H"
  41 #include "forceSuSp.H"
  42 #include "fvMesh.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class ParticleForce Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class CloudType>
  54 class ParticleForce
  55 {
  56     // Private data
  57
  58         //- Reference to the owner cloud
  59         CloudType& owner_;
  60
  61         //- Reference to the mesh database
  62         const fvMesh& mesh_;
  63
  64         //- Force coefficients dictaionary
  65         const dictionary coeffs_;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("particleForce");
  72
  73     //- Declare runtime constructor selection table
  74     declareRunTimeSelectionTable
  75     (
  76         autoPtr,
  77         ParticleForce,
  78         dictionary,
  79         (
  80             CloudType& owner,
  81             const fvMesh& mesh,
  82             const dictionary& dict
  83         ),
  84         (owner, mesh, dict)
  85     );
  86
  87
  88     //- Convenience typedef for return type
  89     typedef VectorSpace<Vector<vector>, vector, 2> returnType;
  90
  91
  92     // Constructors
  93
  94         //- Construct from mesh
  95         ParticleForce
  96         (
  97             CloudType& owner,
  98             const fvMesh& mesh,
  99             const dictionary& dict,
 100             const word& forceType,
 101             const bool readCoeffs
 102         );
 103
 104         //- Construct copy
 105         ParticleForce(const ParticleForce& pf);
 106
 107         //- Construct and return a clone
 108         virtual autoPtr<ParticleForce<CloudType> > clone() const
 109         {
 110             return autoPtr<ParticleForce<CloudType> >
 111             (
 112                 new ParticleForce<CloudType>(*this)
 113             );
 114         }
 115
 116
 117     //- Destructor
 118     virtual ~ParticleForce();
 119
 120
 121     //- Selector
 122     static autoPtr<ParticleForce<CloudType> > New
 123     (
 124         CloudType& owner,
 125         const fvMesh& mesh,
 126         const dictionary& dict,
 127         const word& forceType
 128     );
 129
 130
 131     // Member Functions
 132
 133         // Access
 134
 135             //- Return const access to the cloud owner
 136             inline const CloudType& owner() const;
 137
 138             //- Return refernce to the cloud owner
 139             inline CloudType& owner();
 140
 141             //- Return the mesh database
 142             inline const fvMesh& mesh() const;
 143
 144             //- Return the force coefficients dictionary
 145             inline const dictionary& coeffs() const;
 146
 147
 148         // Evaluation
 149
 150             //- Cache fields
 151             virtual void cacheFields(const bool store);
 152
 153             //- Calculate the coupled force
 154             virtual forceSuSp calcCoupled
 155             (
 156                 const typename CloudType::parcelType& p,
 157                 const scalar dt,
 158                 const scalar mass,
 159                 const scalar Re,
 160                 const scalar muc
 161             ) const;
 162
 163             //- Calculate the non-coupled force
 164             virtual forceSuSp calcNonCoupled
 165             (
 166                 const typename CloudType::parcelType& p,
 167                 const scalar dt,
 168                 const scalar mass,
 169                 const scalar Re,
 170                 const scalar muc
 171             ) const;
 172 };
 173
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 } // End namespace Foam
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #include "ParticleForceI.H"
 182
 183 #ifdef NoRepository
 184     #include "ParticleForce.C"
 185 #endif
 186
 187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 188
 189 #define makeParticleForceModel(CloudType)                                     \
 190                                                                               \
 191     typedef CloudType::kinematicCloudType kinematicCloudType;                 \
 192     defineNamedTemplateTypeNameAndDebug(ParticleForce<kinematicCloudType>, 0);\
 193     defineTemplateRunTimeSelectionTable                                       \
 194     (                                                                         \
 195         ParticleForce<kinematicCloudType>,                                    \
 196         dictionary                                                            \
 197     );
 198
 199
 200 #define makeParticleForceModelType(SS, CloudType)                             \
 201                                                                               \
 202     typedef CloudType::kinematicCloudType kinematicCloudType;                 \
 203     defineNamedTemplateTypeNameAndDebug(SS<kinematicCloudType>, 0);           \
 204                                                                               \
 205     ParticleForce<kinematicCloudType>::                                       \
 206         adddictionaryConstructorToTable<SS<kinematicCloudType> >              \
 207         add##SS##CloudType##kinematicCloudType##ConstructorToTable_;
 208
 209
 210 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 211
 212
 213 #endif
 214
 215 // ************************************************************************* //