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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2012-2017 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::VirtualMassForce
28
29Group
30 grpLagrangianIntermediateForceSubModels
31
32Description
33 Calculates particle virtual mass force
34
35SourceFiles
36 VirtualMassForce.C
37
38\*---------------------------------------------------------------------------*/
39
40#ifndef VirtualMassForce_H
41#define VirtualMassForce_H
42
44
45// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47namespace Foam
48{
49
50/*---------------------------------------------------------------------------*\
51 Class VirtualMassForce Declaration
52\*---------------------------------------------------------------------------*/
53
54template<class CloudType>
56:
57 public PressureGradientForce<CloudType>
58{
59 // Private data
60
61 //- Virtual mass coefficient - typically 0.5
62 scalar Cvm_;
63
64
65public:
66
67 //- Runtime type information
68 TypeName("virtualMass");
69
70
71 // Constructors
72
73 //- Construct from mesh
75 (
77 const fvMesh& mesh,
78 const dictionary& dict,
79 const word& forceType = typeName
80 );
81
82 //- Construct copy
84
85 //- Construct and return a clone
87 {
89 (
91 );
92 }
93
94
95 //- Destructor
96 virtual ~VirtualMassForce();
97
98
99 // Member Functions
100
101 // Evaluation
102
103 //- Cache fields
104 virtual void cacheFields(const bool store);
105
106 //- Calculate the non-coupled force
107 virtual forceSuSp calcCoupled
108 (
109 const typename CloudType::parcelType& p,
110 const typename CloudType::parcelType::trackingData& td,
111 const scalar dt,
112 const scalar mass,
113 const scalar Re,
114 const scalar muc
115 ) const;
116
117 //- Return the added mass
118 virtual scalar massAdd
119 (
120 const typename CloudType::parcelType& p,
121 const typename CloudType::parcelType::trackingData& td,
122 const scalar mass
123 ) const;
124};
125
126
127// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128
129} // End namespace Foam
130
131// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132
133#ifdef NoRepository
134 #include "VirtualMassForce.C"
135#endif
136
137// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138
139#endif
140
141// ************************************************************************* //
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:220
const CloudType & owner() const
Return const access to the cloud owner.
const fvMesh & mesh() const
Return the mesh database.
Calculates particle pressure gradient force.
Calculates particle virtual mass force.
virtual autoPtr< ParticleForce< CloudType > > clone() const
Construct and return a clone.
virtual ~VirtualMassForce()
Destructor.
virtual void cacheFields(const bool store)
Cache fields.
TypeName("virtualMass")
Runtime type information.
virtual scalar massAdd(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
Return the added mass.
virtual forceSuSp calcCoupled(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Calculate the non-coupled force.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Class used to pass data into container.
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:67
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
A class for handling words, derived from Foam::string.
Definition: word.H:68
volScalarField & p
Namespace for OpenFOAM.
scalarField Re(const UList< complex > &cf)
Extract real component.
Definition: complexField.C:159
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73