KinematicLookupTableInjection.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::KinematicLookupTableInjection
26 
27 Description
28  Particle injection sources read from look-up table. Each row corresponds to
29  an injection site.
30 
31  \verbatim
32  (
33  (x y z) (u v w) d rho mDot // injector 1
34  (x y z) (u v w) d rho mDot // injector 2
35  ...
36  (x y z) (u v w) d rho mDot // injector N
37  );
38  \endverbatim
39 
40  where:
41  \plaintable
42  x, y, z | global cartesian co-ordinates [m]
43  u, v, w | global cartesian velocity components [m/s]
44  d | diameter [m]
45  rho | density [kg/m3]
46  mDot | mass flow rate [kg/s]
47  \endplaintable
48 
49 SourceFiles
50  KinematicLookupTableInjection.C
51 
52 \*---------------------------------------------------------------------------*/
53 
54 #ifndef KinematicLookupTableInjection_H
55 #define KinematicLookupTableInjection_H
56 
57 #include "InjectionModel.H"
59 
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 
62 namespace Foam
63 {
64 
65 /*---------------------------------------------------------------------------*\
66  Class KinematicLookupTableInjection Declaration
67 \*---------------------------------------------------------------------------*/
68 
69 template<class CloudType>
70 class KinematicLookupTableInjection
71 :
72  public InjectionModel<CloudType>
73 {
74  // Private data
75 
76  //- Name of file containing injector/parcel data
77  const word inputFileName_;
78 
79  //- Injection duration - common to all injection sources
80  scalar duration_;
81 
82  //- Number of parcels per injector - common to all injection sources
83  const scalar parcelsPerSecond_;
84 
85  //- Flag to indicate to randomise injection positions
86  bool randomise_;
87 
88  //- List of injectors
90 
91  //- List of cell labels corresponding to injector positions
92  labelList injectorCells_;
93 
94  //- List of tetFace labels corresponding to injector positions
95  labelList injectorTetFaces_;
96 
97  //- List of tetPt labels corresponding to injector positions
98  labelList injectorTetPts_;
99 
100 
101 public:
102 
103  //- Runtime type information
104  TypeName("kinematicLookupTableInjection");
105 
106 
107  // Constructors
108 
109  //- Construct from dictionary
111  (
112  const dictionary& dict,
113  CloudType& owner,
114  const word& modelName
115  );
116 
117  //- Construct copy
119  (
121  );
122 
123  //- Construct and return a clone
125  {
127  (
129  );
130  }
131 
132 
133  //- Destructor
135 
136 
137  // Member Functions
138 
139  //- Set injector locations when mesh is updated
140  virtual void updateMesh();
141 
142  //- Return the end-of-injection time
143  scalar timeEnd() const;
144 
145  //- Number of parcels to introduce relative to SOI
146  virtual label parcelsToInject(const scalar time0, const scalar time1);
147 
148  //- Volume of parcels to introduce relative to SOI
149  virtual scalar volumeToInject(const scalar time0, const scalar time1);
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 // ************************************************************************* //
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
KinematicLookupTableInjection(const dictionary &dict, CloudType &owner, const word &modelName)
Construct from dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual bool validInjection(const label parcelI)
Return flag to identify whether or not injection of parcelI is.
virtual autoPtr< InjectionModel< CloudType > > clone() const
Construct and return a clone.
virtual void setProperties(const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType &parcel)
Set the parcel properties.
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
Particle injection sources read from look-up table. Each row corresponds to an injection site...
const CloudType & owner() const
Return const access to the owner cloud.
virtual label parcelsToInject(const scalar time0, const scalar time1)
Number of parcels to introduce relative to SOI.
scalar timeEnd() const
Return the end-of-injection time.
virtual scalar volumeToInject(const scalar time0, const scalar time1)
Volume of parcels to introduce relative to SOI.
A class for handling words, derived from string.
Definition: word.H:59
virtual void updateMesh()
Set injector locations when mesh is updated.
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:218
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 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.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
virtual bool fullyDescribed() const
Flag to identify whether model fully describes the parcel.
Namespace for OpenFOAM.
TypeName("kinematicLookupTableInjection")
Runtime type information.