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>
127 Foam::scalar
129 (
130  const scalar t0,
131  const scalar t1
132 )
133 {
134  if (t1 >= 0 && t0 < duration_)
135  {
136  return
137  injectorCells_.size()
138  *parcelsPerSecond_->integral(max(t0, 0), min(t1, duration_));
139  }
140  else
141  {
142  return 0;
143  }
144 }
145 
146 
147 template<class CloudType>
148 Foam::scalar
150 (
151  const scalar t0,
152  const scalar t1
153 )
154 {
155  scalar mass = 0;
156 
157  if (t1 >= 0 && t0 < duration_)
158  {
159  forAll(injectors_, i)
160  {
161  mass += injectors_[i].mDot()*(min(t1, duration_) - max(t0, 0));
162  }
163  }
164 
165  return mass;
166 }
167 
168 
169 template<class CloudType>
171 (
172  const label parcelI,
173  const label nParcels,
174  const scalar time,
176  label& celli,
177  label& tetFacei,
178  label& tetPti,
179  label& facei
180 )
181 {
182  label injectorI = 0;
183  if (randomise_)
184  {
185  randomGenerator& rndGen = this->owner().rndGen();
186  injectorI = rndGen.sampleAB<label>(0, injectorCells_.size());
187  }
188  else
189  {
190  injectorI = parcelI*injectorCells_.size()/nParcels;
191  }
192 
193  coordinates = injectorCoordinates_[injectorI];
194  celli = injectorCells_[injectorI];
195  tetFacei = injectorTetFaces_[injectorI];
196  tetPti = injectorTetPts_[injectorI];
197 }
198 
199 
200 template<class CloudType>
202 (
203  const label parcelI,
204  const label nParcels,
205  const scalar,
206  typename CloudType::parcelType::trackingData& td,
207  typename CloudType::parcelType& parcel
208 )
209 {
210  label injectorI = parcelI*injectorCells_.size()/nParcels;
211 
212  // set particle velocity
213  parcel.U() = injectors_[injectorI].U();
214 
215  // set particle diameter
216  parcel.d() = injectors_[injectorI].d();
217 
218  // set particle density
219  parcel.rho() = injectors_[injectorI].rho();
220 
221  // set particle temperature
222  parcel.T() = injectors_[injectorI].T();
223 
224  // set particle specific heat capacity
225  parcel.Cp() = injectors_[injectorI].Cp();
226 
227  // set particle component mass fractions
228  parcel.Y() = injectors_[injectorI].Y();
229 
230  // set particle gaseous component mass fractions
231  parcel.YGas() = injectors_[injectorI].YGas();
232 
233  // set particle liquid component mass fractions
234  parcel.YLiquid() = injectors_[injectorI].YLiquid();
235 
236  // set particle solid component mass fractions
237  parcel.YSolid() = injectors_[injectorI].YSolid();
238 }
239 
240 
241 template<class CloudType>
242 bool
244 {
245  return true;
246 }
247 
248 
249 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:433
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 scalar nParcelsToInject(const scalar time0, const scalar time1)
Number of parcels to introduce relative to SOI.
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 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 keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
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
barycentric coordinates(const polyMesh &mesh, const point &position, const label celli, const label facei, const label faceTrii, const scalar stepFraction)
Return the coordinates given the position and tet topology.
Definition: tracking.C:1259
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
layerAndWeight min(const layerAndWeight &a, const layerAndWeight &b)
layerAndWeight max(const layerAndWeight &a, const layerAndWeight &b)
dictionary dict
randomGenerator rndGen(653213)