VirtualMassForce.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2012-2016 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::VirtualMassForce
26 
27 Description
28  Calculates particle virtual mass force
29 
30 SourceFiles
31  VirtualMassForce.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef VirtualMassForce_H
36 #define VirtualMassForce_H
37 
38 #include "PressureGradientForce.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class VirtualMassForce Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class CloudType>
50 class VirtualMassForce
51 :
52  public PressureGradientForce<CloudType>
53 {
54  // Private data
55 
56  //- Virtual mass coefficient - typically 0.5
57  scalar Cvm_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("virtualMass");
64 
65 
66  // Constructors
67 
68  //- Construct from mesh
70  (
72  const fvMesh& mesh,
73  const dictionary& dict,
74  const word& forceType = typeName
75  );
76 
77  //- Construct copy
79 
80  //- Construct and return a clone
82  {
84  (
86  );
87  }
88 
89 
90  //- Destructor
91  virtual ~VirtualMassForce();
92 
93 
94  // Member Functions
95 
96  // Evaluation
97 
98  //- Cache fields
99  virtual void cacheFields(const bool store);
100 
101  //- Calculate the non-coupled force
102  virtual forceSuSp calcCoupled
103  (
104  const typename CloudType::parcelType& p,
105  const scalar dt,
106  const scalar mass,
107  const scalar Re,
108  const scalar muc
109  ) const;
110 
111  //- Return the added mass
112  virtual scalar massAdd
113  (
114  const typename CloudType::parcelType& p,
115  const scalar mass
116  ) const;
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #ifdef NoRepository
127  #include "VirtualMassForce.C"
128 #endif
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
dictionary dict
virtual autoPtr< ParticleForce< CloudType > > clone() const
Construct and return a clone.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~VirtualMassForce()
Destructor.
const fvMesh & mesh() const
Return the mesh database.
VirtualMassForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType=typeName)
Construct from mesh.
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:61
Calculates particle virtual mass force.
virtual void cacheFields(const bool store)
Cache fields.
Calculates particle pressure gradient force.
A class for handling words, derived from string.
Definition: word.H:59
virtual scalar massAdd(const typename CloudType::parcelType &p, const scalar mass) const
Return the added mass.
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:217
TypeName("virtualMass")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
const CloudType & owner() const
Return const access to the cloud owner.
virtual forceSuSp calcCoupled(const typename CloudType::parcelType &p, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Calculate the non-coupled force.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
volScalarField & p
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:68
scalarField Re(const UList< complex > &cf)
Definition: complexFields.C:97
Namespace for OpenFOAM.