ETAB.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) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::ETAB
28 
29 Group
30  grpLagrangianIntermediateBreakupSubModels
31 
32 Description
33  The Enhanced TAB model.
34 
35  Described in the papers below.
36  @verbatim
37  F.X. Tanner
38  "Liquid Jet Atomization and Droplet Breakup Modeling of
39  Non-Evaporating Diesel Fuel Sprays"
40  SAE 970050,
41  SAE Transactions: Journal of Engines, Vol 106, Sec 3 pp 127-140
42 
43  F.X. Tanner and G. Weisser
44  "Simulation of Liquid Jet Atomization for
45  Fuel Sprays by Means of Cascade Drop Breakup Model"
46  SAE 980808
47  SAE Technical Paper Series
48  @endverbatim
49 
50 See also
51  The TAB model
52 
53 \*---------------------------------------------------------------------------*/
54 
55 #ifndef ETAB_H
56 #define ETAB_H
57 
58 #include "BreakupModel.H"
59 
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 
62 namespace Foam
63 {
64 /*---------------------------------------------------------------------------*\
65  Class ETAB Declaration
66 \*---------------------------------------------------------------------------*/
67 
68 template<class CloudType>
69 class ETAB
70 :
71  public BreakupModel<CloudType>
72 {
73 private:
74 
75  // Private data
76 
77  // Model constants
78 
79  scalar k1_;
80  scalar k2_;
81  scalar WeTransition_;
82  scalar AWe_;
83 
84 
85 public:
86 
87  //- Runtime type information
88  TypeName("ETAB");
89 
90 
91  // Constructors
92 
93  //- Construct from dictionary
94  ETAB(const dictionary&, CloudType&);
95 
96  //- Construct copy
97  ETAB(const ETAB<CloudType>& bum);
98 
99  //- Construct and return a clone
100  virtual autoPtr<BreakupModel<CloudType>> clone() const
101  {
103  (
104  new ETAB<CloudType>(*this)
105  );
106  }
107 
108 
109  //- Destructor
110  virtual ~ETAB();
111 
112 
113  // Member Functions
114 
115  //- Update the parcel properties
116  virtual bool update
117  (
118  const scalar dt,
119  const vector& g,
120  scalar& d,
121  scalar& tc,
122  scalar& ms,
123  scalar& nParticle,
124  scalar& KHindex,
125  scalar& y,
126  scalar& yDot,
127  const scalar d0,
128  const scalar rho,
129  const scalar mu,
130  const scalar sigma,
131  const vector& U,
132  const scalar rhoc,
133  const scalar muc,
134  const vector& Urel,
135  const scalar Urmag,
136  const scalar tMom,
137  scalar& dChild,
138  scalar& massChild
139  );
140 };
141 
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 } // End namespace Foam
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 #ifdef NoRepository
150  #include "ETAB.C"
151 #endif
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 #endif
156 
157 // ************************************************************************* //
Foam::ETAB::TypeName
TypeName("ETAB")
Runtime type information.
Foam::ETAB::~ETAB
virtual ~ETAB()
Destructor.
Definition: ETAB.C:71
Foam::constant::physicoChemical::mu
const dimensionedScalar mu
Atomic mass unit.
Definition: createFieldRefs.H:4
Urel
Urel
Definition: pEqn.H:56
Foam::ETAB::update
virtual bool update(const scalar dt, const vector &g, scalar &d, scalar &tc, scalar &ms, scalar &nParticle, scalar &KHindex, scalar &y, scalar &yDot, const scalar d0, const scalar rho, const scalar mu, const scalar sigma, const vector &U, const scalar rhoc, const scalar muc, const vector &Urel, const scalar Urmag, const scalar tMom, scalar &dChild, scalar &massChild)
Update the parcel properties.
Definition: ETAB.C:79
Foam::ETAB::clone
virtual autoPtr< BreakupModel< CloudType > > clone() const
Construct and return a clone.
Definition: ETAB.H:99
rho
rho
Definition: readInitialConditions.H:96
Foam::DSMCCloud
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:71
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
ETAB.C
g
const uniformDimensionedVectorField & g
Definition: createFluidFields.H:24
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::BreakupModel
Templated break-up model class.
Definition: SprayCloud.H:49
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
U
U
Definition: pEqn.H:72
BreakupModel.H
Foam::Vector< scalar >
sigma
dimensionedScalar sigma("sigma", dimMass/sqr(dimTime), transportProperties)
Foam::ETAB
The Enhanced TAB model.
Definition: ETAB.H:68
Foam::ETAB::ETAB
ETAB(const dictionary &, CloudType &)
Construct from dictionary.
Definition: ETAB.C:34
y
scalar y
Definition: LISASMDCalcMethod1.H:14