ReactingLookupTableInjection.H
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-2018 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 Class
25  Foam::ReactingLookupTableInjection
26 
27 Description
28  Particle injection sources read from look-up table. Each row corresponds to
29  an injection site.
30 
31  (
32  (x y z) (u v w) d rho mDot T cp (Y0..YN) // injector 1
33  (x y z) (u v w) d rho mDot T cp (Y0..YN) // injector 2
34  ...
35  (x y z) (u v w) d rho mDot T cp (Y0..YN) // injector N
36  );
37 
38  where:
39  x, y, z = global cartesian co-ordinates [m]
40  u, v, w = global cartesian velocity components [m/s]
41  d = diameter [m]
42  rho = density [kg/m3]
43  mDot = mass flow rate [kg/s]
44  T = temperature [K]
45  cp = specific heat capacity [J/kg/K]
46  Y = list of mass fractions
47 
48 SourceFiles
49  ReactingLookupTableInjection.C
50 
51 \*---------------------------------------------------------------------------*/
52 
53 #ifndef ReactingLookupTableInjection_H
54 #define ReactingLookupTableInjection_H
55 
56 #include "InjectionModel.H"
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 namespace Foam
62 {
63 
64 /*---------------------------------------------------------------------------*\
65  Class ReactingLookupTableInjection Declaration
66 \*---------------------------------------------------------------------------*/
67 
68 template<class CloudType>
70 :
71  public InjectionModel<CloudType>
72 {
73  // Private data
74 
75  //- Name of file containing injector/parcel data
76  const word inputFileName_;
77 
78  //- Injection duration - common to all injection sources
79  scalar duration_;
80 
81  //- Number of parcels per injector - common to all injection sources
82  const scalar parcelsPerSecond_;
83 
84  //- Flag to indicate to randomise injection positions
85  bool randomise_;
86 
87  //- List of injectors
89 
90  //- List of cell labels corresoponding to injector positions
91  labelList injectorCells_;
92 
93  //- List of tetFace labels corresoponding to injector positions
94  labelList injectorTetFaces_;
95 
96  //- List of tetPt labels corresoponding to injector positions
97  labelList injectorTetPts_;
98 
99 
100 public:
101 
102  //- Runtime type information
103  TypeName("reactingLookupTableInjection");
104 
105 
106  // Constructors
107 
108  //- Construct from dictionary
110  (
111  const dictionary& dict,
112  CloudType& owner,
113  const word& modelName
114  );
115 
116  //- Construct copy
118  (
120  );
121 
122  //- Construct and return a clone
124  {
126  (
128  );
129  }
130 
131 
132  //- Destructor
134 
135 
136  // Member Functions
137 
138  //- Set injector locations when mesh is updated
139  virtual void updateMesh();
140 
141  //- Return the end-of-injection time
142  scalar timeEnd() const;
143 
144  //- Number of parcels to introduce relative to SOI
145  virtual label parcelsToInject(const scalar time0, const scalar time1);
146 
147  //- Volume of parcels to introduce relative to SOI
148  virtual scalar volumeToInject(const scalar time0, const scalar time1);
149 
150 
151 
152  // Injection geometry
153 
154  //- Set the injection position and owner cell, tetFace and tetPt
155  virtual void setPositionAndCell
156  (
157  const label parcelI,
158  const label nParcels,
159  const scalar time,
160  vector& position,
161  label& cellOwner,
162  label& tetFacei,
163  label& tetPti
164  );
165 
166  //- Set the parcel properties
167  virtual void setProperties
168  (
169  const label parcelI,
170  const label nParcels,
171  const scalar time,
172  typename CloudType::parcelType& parcel
173  );
174 
175  //- Flag to identify whether model fully describes the parcel
176  virtual bool fullyDescribed() const;
177 
178  //- Return flag to identify whether or not injection of parcelI is
179  // permitted
180  virtual bool validInjection(const label parcelI);
181 };
182 
183 
184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
185 
186 } // End namespace Foam
187 
188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
189 
190 #ifdef NoRepository
192 #endif
193 
194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
195 
196 #endif
197 
198 // ************************************************************************* //
scalar timeEnd() const
Return the end-of-injection time.
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
TypeName("reactingLookupTableInjection")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Templated injection model class.
virtual bool validInjection(const label parcelI)
Return flag to identify whether or not injection of parcelI is.
virtual void setPositionAndCell(const label parcelI, const label nParcels, const scalar time, vector &position, label &cellOwner, label &tetFacei, label &tetPti)
Set the injection position and owner cell, tetFace and tetPt.
const word & modelName() const
Return const access to the name of the sub-model.
Definition: subModelBase.C:104
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const CloudType & owner() const
Return const access to the owner cloud.
A class for handling words, derived from string.
Definition: word.H:59
Particle injection sources read from look-up table. Each row corresponds to an injection site...
ReactingLookupTableInjection(const dictionary &dict, CloudType &owner, const word &modelName)
Construct from dictionary.
virtual bool fullyDescribed() const
Flag to identify whether model fully describes the parcel.
virtual void setProperties(const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType &parcel)
Set the parcel properties.
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:218
virtual scalar volumeToInject(const scalar time0, const scalar time1)
Volume of parcels to introduce relative to SOI.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual void updateMesh()
Set injector locations when mesh is updated.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
virtual autoPtr< InjectionModel< CloudType > > clone() const
Construct and return a clone.
Namespace for OpenFOAM.
virtual label parcelsToInject(const scalar time0, const scalar time1)
Number of parcels to introduce relative to SOI.