SaffmanMeiLiftForce.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2012-2018 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::SaffmanMeiLiftForce
26 
27 Description
28  Saffman-Mei particle lift force model applicable to spherical particles.
29 
30 SourceFiles
31  SaffmanMeiLiftForce.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef SaffmanMeiLiftForce_H
36 #define SaffmanMeiLiftForce_H
37 
38 #include "LiftForce.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class SaffmanMeiLiftForce Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class CloudType>
51 :
52  public LiftForce<CloudType>
53 {
54 protected:
55 
56  // Protected Member Functions
57 
58  //- Calculate the lift coefficient
59  virtual scalar Cl
60  (
61  const typename CloudType::parcelType& p,
62  const typename CloudType::parcelType::trackingData& td,
63  const vector& curlUc,
64  const scalar Re,
65  const scalar muc
66  ) const;
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("SaffmanMeiLiftForce");
73 
74 
75  // Constructors
76 
77  //- Construct from mesh
79  (
81  const fvMesh& mesh,
82  const dictionary& dict,
83  const word& forceType = typeName
84  );
85 
86  //- Construct copy
88 
89  //- Construct and return a clone
91  {
93  (
95  );
96  }
97 
98 
99  //- Destructor
100  virtual ~SaffmanMeiLiftForce();
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #ifdef NoRepository
111  #include "SaffmanMeiLiftForce.C"
112 #endif
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const fvMesh & mesh() const
Return the mesh database.
const CloudType & owner() const
Return const access to the cloud owner.
virtual scalar Cl(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const vector &curlUc, const scalar Re, const scalar muc) const
Calculate the lift coefficient.
SaffmanMeiLiftForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType=typeName)
Construct from mesh.
virtual ~SaffmanMeiLiftForce()
Destructor.
virtual autoPtr< ParticleForce< CloudType > > clone() const
Construct and return a clone.
A class for handling words, derived from string.
Definition: word.H:59
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:218
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Saffman-Mei particle lift force model applicable to spherical particles.
TypeName("SaffmanMeiLiftForce")
Runtime type information.
Base class for particle lift force models.
Definition: LiftForce.H:52
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
volScalarField & p
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
scalarField Re(const UList< complex > &cf)
Definition: complexFields.C:97
Namespace for OpenFOAM.