ReactingMultiphaseLookupTableInjection.C
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) 2011-2024 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 \*---------------------------------------------------------------------------*/
25 
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class CloudType>
33 (
34  const dictionary& dict,
35  CloudType& owner,
36  const word& modelName
37 )
38 :
39  InjectionModel<CloudType>(dict, owner, modelName, typeName),
40  inputFileName_(this->coeffDict().lookup("inputFile")),
41  duration_(this->readDuration(dict, owner)),
42  parcelsPerSecond_(this->readParcelsPerSecond(dict, owner)),
43  randomise_(readBool(this->coeffDict().lookup("randomise"))),
44  injectors_
45  (
46  IOobject
47  (
48  inputFileName_,
49  owner.db().time().constant(),
50  owner.db(),
51  IOobject::MUST_READ,
52  IOobject::NO_WRITE
53  )
54  ),
55  injectorCoordinates_(0),
56  injectorCells_(0),
57  injectorTetFaces_(0),
58  injectorTetPts_(0)
59 {
60  // Set/cache the injector cells
61  injectorCoordinates_.setSize(injectors_.size());
62  injectorCells_.setSize(injectors_.size());
63  injectorTetFaces_.setSize(injectors_.size());
64  injectorTetPts_.setSize(injectors_.size());
65 
66  topoChange();
67 }
68 
69 
70 template<class CloudType>
73 (
75 )
76 :
78  inputFileName_(im.inputFileName_),
79  duration_(im.duration_),
80  parcelsPerSecond_(im.parcelsPerSecond_, false),
81  randomise_(im.randomise_),
82  injectors_(im.injectors_),
83  injectorCoordinates_(im.injectorCoordinates_),
84  injectorCells_(im.injectorCells_),
85  injectorTetFaces_(im.injectorTetFaces_),
86  injectorTetPts_(im.injectorTetPts_)
87 {}
88 
89 
90 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
91 
92 template<class CloudType>
95 {}
96 
97 
98 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
99 
100 template<class CloudType>
102 {
103  // Set/cache the injector cells
104  forAll(injectors_, i)
105  {
106  this->findCellAtPosition
107  (
108  injectors_[i].x(),
109  injectorCoordinates_[i],
110  injectorCells_[i],
111  injectorTetFaces_[i],
112  injectorTetPts_[i]
113  );
114  }
115 }
116 
117 
118 template<class CloudType>
119 Foam::scalar
121 {
122  return this->SOI_ + duration_;
123 }
124 
125 
126 template<class CloudType>
129 (
130  const scalar time0,
131  const scalar time1
132 )
133 {
134  if (time0 >= 0 && time0 < duration_)
135  {
136  return
137  floor
138  (
139  injectorCells_.size()
140  *parcelsPerSecond_->integral(time0, time1)
141  );
142  }
143  else
144  {
145  return 0;
146  }
147 }
148 
149 
150 template<class CloudType>
151 Foam::scalar
153 (
154  const scalar time0,
155  const scalar time1
156 )
157 {
158  scalar mass = 0;
159 
160  if (time0 >= 0 && time0 < duration_)
161  {
162  forAll(injectors_, i)
163  {
164  mass += injectors_[i].mDot()*(time1 - time0);
165  }
166  }
167 
168  return mass;
169 }
170 
171 
172 template<class CloudType>
174 (
175  const label parcelI,
176  const label nParcels,
177  const scalar time,
178  barycentric& coordinates,
179  label& celli,
180  label& tetFacei,
181  label& tetPti,
182  label& facei
183 )
184 {
185  label injectorI = 0;
186  if (randomise_)
187  {
188  randomGenerator& rndGen = this->owner().rndGen();
189  injectorI = rndGen.sampleAB<label>(0, injectorCells_.size());
190  }
191  else
192  {
193  injectorI = parcelI*injectorCells_.size()/nParcels;
194  }
195 
196  coordinates = injectorCoordinates_[injectorI];
197  celli = injectorCells_[injectorI];
198  tetFacei = injectorTetFaces_[injectorI];
199  tetPti = injectorTetPts_[injectorI];
200 }
201 
202 
203 template<class CloudType>
205 (
206  const label parcelI,
207  const label nParcels,
208  const scalar,
209  typename CloudType::parcelType::trackingData& td,
210  typename CloudType::parcelType& parcel
211 )
212 {
213  label injectorI = parcelI*injectorCells_.size()/nParcels;
214 
215  // set particle velocity
216  parcel.U() = injectors_[injectorI].U();
217 
218  // set particle diameter
219  parcel.d() = injectors_[injectorI].d();
220 
221  // set particle density
222  parcel.rho() = injectors_[injectorI].rho();
223 
224  // set particle temperature
225  parcel.T() = injectors_[injectorI].T();
226 
227  // set particle specific heat capacity
228  parcel.Cp() = injectors_[injectorI].Cp();
229 
230  // set particle component mass fractions
231  parcel.Y() = injectors_[injectorI].Y();
232 
233  // set particle gaseous component mass fractions
234  parcel.YGas() = injectors_[injectorI].YGas();
235 
236  // set particle liquid component mass fractions
237  parcel.YLiquid() = injectors_[injectorI].YLiquid();
238 
239  // set particle solid component mass fractions
240  parcel.YSolid() = injectors_[injectorI].YSolid();
241 }
242 
243 
244 template<class CloudType>
245 bool
247 {
248  return true;
249 }
250 
251 
252 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:80
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:225
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
Templated injection model class.
void setSize(const label)
Reset size of List.
Definition: List.C:281
Particle injection sources read from look-up table. Each row corresponds to an injection site.
virtual void topoChange()
Set injector locations when mesh is updated.
virtual void setProperties(const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType::trackingData &td, typename CloudType::parcelType &parcel)
Set the parcel properties.
virtual void setPositionAndCell(const label parcelI, const label nParcels, const scalar time, barycentric &coordinates, label &celli, label &tetFacei, label &tetPti, label &facei)
Set the injection position and owner cell, tetFace and tetPt.
ReactingMultiphaseLookupTableInjection(const dictionary &dict, CloudType &owner, const word &modelName)
Construct from dictionary.
virtual label nParcelsToInject(const scalar time0, const scalar time1)
Number of parcels to introduce relative to SOI.
virtual bool fullyDescribed() const
Flag to identify whether model fully describes the parcel.
scalar timeEnd() const
Return the end-of-injection time.
virtual scalar massToInject(const scalar time0, const scalar time1)
Parcel mass to introduce relative to SOI.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Random number generator.
Type sampleAB(const Type &a, const Type &b)
Return a type with components uniformly distributed between two.
A class for handling words, derived from string.
Definition: word.H:62
bool readBool(Istream &)
Definition: boolIO.C:66
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
dictionary dict
randomGenerator rndGen(653213)