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-2026 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 :
40  inputFileName_(this->typeDict().lookup("inputFile")),
41  duration_(this->readDuration(dict, owner)),
42  parcelsPerSecond_(this->readParcelsPerSecond(dict, owner)),
43  randomise_(readBool(this->typeDict().lookup("randomise"))),
44  injectors_
45  (
46  IOobject
47  (
48  inputFileName_,
49  owner.time().constant(),
50  owner.parent(),
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  const meshSearch& searchEngine = meshSearch::New(this->owner().mesh());
102 
103  // Set/cache the injector cells
104  forAll(injectors_, i)
105  {
106  this->findCellAtPosition
107  (
108  searchEngine,
109  injectors_[i].x(),
110  injectorCoordinates_[i],
111  injectorCells_[i],
112  injectorTetFaces_[i],
113  injectorTetPts_[i]
114  );
115  }
116 }
117 
118 
119 template<class CloudType>
121 {
122  return this->SOI_ + duration_;
123 }
124 
125 
126 template<class CloudType>
128 (
129  const scalar t0,
130  const scalar t1
131 )
132 {
133  if (t1 >= 0 && t0 < duration_)
134  {
135  return
136  injectorCells_.size()
137  *parcelsPerSecond_->integral(max(t0, 0), min(t1, duration_));
138  }
139  else
140  {
141  return 0;
142  }
143 }
144 
145 
146 template<class CloudType>
148 (
149  const scalar t0,
150  const scalar t1
151 )
152 {
153  scalar mass = 0;
154 
155  if (t1 >= 0 && t0 < duration_)
156  {
157  forAll(injectors_, i)
158  {
159  mass += injectors_[i].mDot()*(min(t1, duration_) - max(t0, 0));
160  }
161  }
162 
163  return mass;
164 }
165 
166 
167 template<class CloudType>
169 (
170  const meshSearch& searchEngine,
171  const label parcelI,
172  const label nParcels,
173  const scalar time,
175  label& celli,
176  label& tetFacei,
177  label& tetPti,
178  label& facei
179 )
180 {
181  label injectorI = 0;
182  if (randomise_)
183  {
184  randomGenerator& rndGen = this->owner().rndGen();
185  injectorI = rndGen.sampleAB<label>(0, injectorCells_.size());
186  }
187  else
188  {
189  injectorI = parcelI*injectorCells_.size()/nParcels;
190  }
191 
192  coordinates = injectorCoordinates_[injectorI];
193  celli = injectorCells_[injectorI];
194  tetFacei = injectorTetFaces_[injectorI];
195  tetPti = injectorTetPts_[injectorI];
196 }
197 
198 
199 template<class CloudType>
201 (
202  const label parcelI,
203  const label nParcels,
204  const scalar,
205  typename CloudType::parcelType::trackingData& td,
206  typename CloudType::parcelType& parcel
207 )
208 {
209  label injectorI = parcelI*injectorCells_.size()/nParcels;
210 
211  // set particle velocity
212  parcel.U() = injectors_[injectorI].U();
213 
214  // set particle diameter
215  parcel.d() = injectors_[injectorI].d();
216 
217  // set particle density
218  parcel.rho() = injectors_[injectorI].rho();
219 
220  // set particle temperature
221  parcel.T() = injectors_[injectorI].T();
222 
223  // set particle specific heat capacity
224  parcel.Cp() = injectors_[injectorI].Cp();
225 }
226 
227 
228 template<class CloudType>
230 {
231  return true;
232 }
233 
234 
235 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:449
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 meshSearch &searchEngine, 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
Mesh object that implements searches within the local cells and faces.
Definition: meshSearch.H:59
static const meshSearch & New(const polyMesh &mesh, const pointInCellShapes=pointInCellShapes::tets)
Lookup or construct from mesh and cell decomposition option.
Definition: meshSearch.C:61
Random number generator.
Type sampleAB(const Type &a, const Type &b)
Return a type with components uniformly distributed between two.
Template function which returns the un-mangled name of a given type. Useful for types which do not ha...
A class for handling words, derived from string.
Definition: word.H:63
Foam::fvMesh mesh(Foam::IOobject(regionName, runTime.name(), runTime, Foam::IOobject::MUST_READ), false)
const dimensionSet time
const dimensionSet mass
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:1258
const unitSet & lookup(const word &unitName)
Lookup and return the named unit from the table.
Definition: units.C:346
bool readBool(Istream &)
Definition: boolIO.C:63
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
dimensioned< Type > min(const DimensionedField< Type, GeoMesh, PrimitiveField > &df)
dimensioned< Type > max(const DimensionedField< Type, GeoMesh, PrimitiveField > &df)
dictionary dict
randomGenerator rndGen(653213)