src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::FieldActivatedInjection
  27
  28 Description
  29     Injection at specified positions, with the conditions:
  30
  31     - for injection to be allowed
  32
  33         factor*referenceField[cellI] >= thresholdField[cellI]
  34
  35         where:
  36           - referenceField is the field used to supply the look-up values
  37           - thresholdField supplies the values beyond which the injection is
  38             permitted
  39
  40     - limited to a user-supllied number of injections per injector location
  41
  42 SourceFiles
  43     FieldActivatedInjection.C
  44
  45 \*---------------------------------------------------------------------------*/
  46
  47 #ifndef FieldActivatedInjection_H
  48 #define FieldActivatedInjection_H
  49
  50 #include "InjectionModel.H"
  51 #include "pdf.H"
  52 #include "volFieldsFwd.H"
  53
  54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  55
  56 namespace Foam
  57 {
  58
  59 /*---------------------------------------------------------------------------*\
  60                     Class FieldActivatedInjection Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class CloudType>
  64 class FieldActivatedInjection
  65 :
  66     public InjectionModel<CloudType>
  67 {
  68     // Private data
  69
  70         // Model parameters
  71
  72             //- Factor to apply to reference field
  73             const scalar factor_;
  74
  75             //- Reference field
  76             const volScalarField& referenceField_;
  77
  78             //- Threshold field
  79             const volScalarField& thresholdField_;
  80
  81
  82         // Injector properties
  83
  84             //- Name of file containing positions data
  85             const word positionsFile_;
  86
  87             //- Field of injector (x,y,z) positions
  88             vectorIOField positions_;
  89
  90             //- Field of cell labels corresponding to injector positions
  91             labelList injectorCells_;
  92
  93             //- Number of parcels per injector
  94             const label nParcelsPerInjector_;
  95
  96             //- Field of number of parcels injected for each injector
  97             labelList nParcelsInjected_;
  98
  99
 100         // Parcel properties
 101
 102             //- Initial parcel velocity
 103             const vector U0_;
 104
 105             //- Field of parcel diameters
 106             scalarList diameters_;
 107
 108             //- Parcel size PDF model
 109             const autoPtr<pdf> parcelPDF_;
 110
 111
 112 protected:
 113
 114     // Protected member functions
 115
 116         //- Number of parcels to introduce over the time step relative to SOI
 117         label parcelsToInject
 118         (
 119             const scalar time0,
 120             const scalar time1
 121         ) const;
 122
 123         //- Volume of parcels to introduce over the time step relative to SOI
 124         scalar volumeToInject
 125         (
 126             const scalar time0,
 127             const scalar time1
 128         ) const;
 129
 130
 131 public:
 132
 133     //- Runtime type information
 134     TypeName("FieldActivatedInjection");
 135
 136
 137     // Constructors
 138
 139         //- Construct from dictionary
 140         FieldActivatedInjection
 141         (
 142             const dictionary& dict,
 143             CloudType& owner
 144         );
 145
 146
 147     // Destructor
 148     virtual ~FieldActivatedInjection();
 149
 150
 151     // Member Functions
 152
 153         //- Flag to indicate whether model activates injection model
 154         bool active() const;
 155
 156         //- Return the end-of-injection time
 157         scalar timeEnd() const;
 158
 159
 160         // Injection geometry
 161
 162             //- Set the injection position and owner cell
 163             virtual void setPositionAndCell
 164             (
 165                 const label parcelI,
 166                 const label nParcels,
 167                 const scalar time,
 168                 vector& position,
 169                 label& cellOwner
 170             );
 171
 172             //- Set the parcel properties
 173             virtual void setProperties
 174             (
 175                 const label parcelI,
 176                 const label nParcels,
 177                 const scalar time,
 178                 typename CloudType::parcelType& parcel
 179             );
 180
 181             //- Flag to identify whether model fully describes the parcel
 182             virtual bool fullyDescribed() const;
 183
 184             //- Return flag to identify whether or not injection of parcelI is
 185             //  permitted
 186             virtual bool validInjection(const label parcelI);
 187 };
 188
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 } // End namespace Foam
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 #ifdef NoRepository
 197 #   include "FieldActivatedInjection.C"
 198 #endif
 199
 200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 201
 202 #endif
 203
 204 // ************************************************************************* //