NoInjection.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::NoInjection
26 
27 Description
28  Place holder for 'none' option
29 
30 SourceFiles
31  NoInjection.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef NoInjection_H
36 #define NoInjection_H
37 
38 #include "InjectionModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class NoInjection Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class CloudType>
50 class NoInjection
51 :
52  public InjectionModel<CloudType>
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("none");
59 
60 
61  // Constructors
62 
63  //- Construct from components
64  NoInjection(const dictionary&, CloudType&, const word&);
65 
66  //- Construct copy
68 
69  //- Construct and return a clone
71  {
73  (
74  new NoInjection<CloudType>(*this)
75  );
76  }
77 
78 
79  //- Destructor
80  virtual ~NoInjection();
81 
82 
83  // Member Functions
84 
85  //- Flag to indicate whether model activates injection model
86  bool active() const;
87 
88  //- Return the end-of-injection time
89  scalar timeEnd() const;
90 
91  //- Number of parcels to introduce relative to SOI
92  virtual label parcelsToInject(const scalar time0, const scalar time1);
93 
94  //- Volume of parcels to introduce relative to SOI
95  virtual scalar volumeToInject(const scalar time0, const scalar time1);
96 
97 
98  // Injection geometry
99 
100  //- Set the injection position and owner cell, tetFace and tetPt
101  virtual void setPositionAndCell
102  (
103  const label parcelI,
104  const label nParcels,
105  const scalar time,
106  vector& position,
107  label& cellOwner,
108  label& tetFacei,
109  label& tetPti
110  );
111 
112  virtual void setProperties
113  (
114  const label parcelI,
115  const label nParcels,
116  const scalar time,
117  typename CloudType::parcelType& parcel
118  );
119 
120  //- Flag to identify whether model fully describes the parcel
121  virtual bool fullyDescribed() const;
122 
123  //- Return flag to identify whether or not injection of parcelI is
124  // permitted
125  virtual bool validInjection(const label parcelI);
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #ifdef NoRepository
136  #include "NoInjection.C"
137 #endif
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
virtual bool validInjection(const label parcelI)
Return flag to identify whether or not injection of parcelI is.
Definition: NoInjection.C:134
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void setProperties(const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType &parcel)
Set the parcel properties.
Definition: NoInjection.C:111
TypeName("none")
Runtime type information.
Templated injection model class.
virtual autoPtr< InjectionModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoInjection.H:69
NoInjection(const dictionary &, CloudType &, const word &)
Construct from components.
Definition: NoInjection.C:33
A class for handling words, derived from string.
Definition: word.H:59
virtual scalar volumeToInject(const scalar time0, const scalar time1)
Volume of parcels to introduce relative to SOI.
Definition: NoInjection.C:86
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:218
scalar timeEnd() const
Return the end-of-injection time.
Definition: NoInjection.C:67
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.
Definition: NoInjection.C:97
Place holder for &#39;none&#39; option.
Definition: NoInjection.H:49
virtual label parcelsToInject(const scalar time0, const scalar time1)
Number of parcels to introduce relative to SOI.
Definition: NoInjection.C:75
virtual bool fullyDescribed() const
Flag to identify whether model fully describes the parcel.
Definition: NoInjection.C:127
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 ~NoInjection()
Destructor.
Definition: NoInjection.C:53
bool active() const
Flag to indicate whether model activates injection model.
Definition: NoInjection.C:60
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
Namespace for OpenFOAM.