ThermoLookupTableInjection.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 #include "scalarIOList.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 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>
72 (
74 )
75 :
77  inputFileName_(im.inputFileName_),
78  duration_(im.duration_),
79  parcelsPerSecond_(im.parcelsPerSecond_, false),
80  randomise_(im.randomise_),
81  injectors_(im.injectors_),
82  injectorCoordinates_(im.injectorCoordinates_),
83  injectorCells_(im.injectorCells_),
84  injectorTetFaces_(im.injectorTetFaces_),
85  injectorTetPts_(im.injectorTetPts_)
86 {}
87 
88 
89 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
90 
91 template<class CloudType>
93 {}
94 
95 
96 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
97 
98 template<class CloudType>
100 {
101  // Set/cache the injector cells
102  forAll(injectors_, i)
103  {
104  this->findCellAtPosition
105  (
106  injectors_[i].x(),
107  injectorCoordinates_[i],
108  injectorCells_[i],
109  injectorTetFaces_[i],
110  injectorTetPts_[i]
111  );
112  }
113 }
114 
115 
116 template<class CloudType>
118 {
119  return this->SOI_ + duration_;
120 }
121 
122 
123 template<class CloudType>
125 (
126  const scalar t0,
127  const scalar t1
128 )
129 {
130  if (t1 >= 0 && t0 < duration_)
131  {
132  return
133  injectorCells_.size()
134  *parcelsPerSecond_->integral(max(t0, 0), min(t1, duration_));
135  }
136  else
137  {
138  return 0;
139  }
140 }
141 
142 
143 template<class CloudType>
145 (
146  const scalar t0,
147  const scalar t1
148 )
149 {
150  scalar mass = 0;
151 
152  if (t1 >= 0 && t0 < duration_)
153  {
154  forAll(injectors_, i)
155  {
156  mass += injectors_[i].mDot()*(min(t1, duration_) - max(t0, 0));
157  }
158  }
159 
160  return mass;
161 }
162 
163 
164 template<class CloudType>
166 (
167  const label parcelI,
168  const label nParcels,
169  const scalar time,
171  label& celli,
172  label& tetFacei,
173  label& tetPti,
174  label& facei
175 )
176 {
177  label injectorI = 0;
178  if (randomise_)
179  {
180  randomGenerator& rndGen = this->owner().rndGen();
181  injectorI = rndGen.sampleAB<label>(0, injectorCells_.size());
182  }
183  else
184  {
185  injectorI = parcelI*injectorCells_.size()/nParcels;
186  }
187 
188  coordinates = injectorCoordinates_[injectorI];
189  celli = injectorCells_[injectorI];
190  tetFacei = injectorTetFaces_[injectorI];
191  tetPti = injectorTetPts_[injectorI];
192 }
193 
194 
195 template<class CloudType>
197 (
198  const label parcelI,
199  const label nParcels,
200  const scalar,
201  typename CloudType::parcelType::trackingData& td,
202  typename CloudType::parcelType& parcel
203 )
204 {
205  label injectorI = parcelI*injectorCells_.size()/nParcels;
206 
207  // set particle velocity
208  parcel.U() = injectors_[injectorI].U();
209 
210  // set particle diameter
211  parcel.d() = injectors_[injectorI].d();
212 
213  // set particle density
214  parcel.rho() = injectors_[injectorI].rho();
215 
216  // set particle temperature
217  parcel.T() = injectors_[injectorI].T();
218 
219  // set particle specific heat capacity
220  parcel.Cp() = injectors_[injectorI].Cp();
221 }
222 
223 
224 template<class CloudType>
226 {
227  return true;
228 }
229 
230 
231 // ************************************************************************* //
#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.
ThermoLookupTableInjection(const dictionary &dict, CloudType &owner, const word &modelName)
Construct from dictionary.
virtual void setPositionAndCell(const label parcelI, const label nParcels, const scalar time, barycentric &coordinates, label &cellOwner, label &tetFacei, label &tetPti, label &facei)
Set the injection position and owner cell, tetFace and tetPt.
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)