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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-2009 OpenCFD Ltd.
   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::PatchInjection
  27
  28 Description
  29     Patch injection
  30
  31     - User specifies
  32       - Total mass to inject
  33       - Name of patch
  34       - Injection duration
  35       - Initial parcel velocity
  36       - Injection volume flow rate
  37     - Parcel diameters obtained by PDF model
  38     - Parcels injected at cell centres adjacent to patch
  39
  40 SourceFiles
  41     PatchInjection.C
  42
  43 \*---------------------------------------------------------------------------*/
  44
  45 #ifndef PatchInjection_H
  46 #define PatchInjection_H
  47
  48 #include "InjectionModel.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 template<class Type>
  56 class DataEntry;
  57
  58 class pdf;
  59
  60 /*---------------------------------------------------------------------------*\
  61                        Class PatchInjection Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 template<class CloudType>
  65 class PatchInjection
  66 :
  67     public InjectionModel<CloudType>
  68 {
  69     // Private data
  70
  71         //- Name of patch
  72         const word patchName_;
  73
  74         //- Injection duration [s]
  75         const scalar duration_;
  76
  77         //- Number of parcels to introduce per second []
  78         const label parcelsPerSecond_;
  79
  80         //- Initial parcel velocity [m/s]
  81         const vector U0_;
  82
  83         //- Volume flow rate of parcels to introduce relative to SOI [m^3/s]
  84         const autoPtr<DataEntry<scalar> > volumeFlowRate_;
  85
  86         //- Parcel size PDF model
  87         const autoPtr<pdf> parcelPDF_;
  88
  89         //- Cell owners
  90         labelList cellOwners_;
  91
  92         //- Fraction of injection controlled by this processor
  93         scalar fraction_;
  94
  95
  96 protected:
  97
  98     // Protected member functions
  99
 100         //- Number of parcels to introduce over the time step relative to SOI
 101         label parcelsToInject
 102         (
 103             const scalar time0,
 104             const scalar time1
 105         ) const;
 106
 107         //- Volume of parcels to introduce over the time step relative to SOI
 108         scalar volumeToInject
 109         (
 110             const scalar time0,
 111             const scalar time1
 112         ) const;
 113
 114
 115 public:
 116
 117     //- Runtime type information
 118     TypeName("PatchInjection");
 119
 120
 121     // Constructors
 122
 123         //- Construct from dictionary
 124         PatchInjection
 125         (
 126             const dictionary& dict,
 127             CloudType& owner
 128         );
 129
 130
 131     //- Destructor
 132     virtual ~PatchInjection();
 133
 134
 135     // Member Functions
 136
 137         //- Flag to indicate whether model activates injection model
 138         bool active() const;
 139
 140         //- Return the end-of-injection time
 141         scalar timeEnd() const;
 142
 143
 144         // Injection geometry
 145
 146             //- Set the injection position and owner cell
 147             virtual void setPositionAndCell
 148             (
 149                 const label parcelI,
 150                 const label nParcels,
 151                 const scalar time,
 152                 vector& position,
 153                 label& cellOwner
 154             );
 155
 156             virtual void setProperties
 157             (
 158                 const label parcelI,
 159                 const label nParcels,
 160                 const scalar time,
 161                 typename CloudType::parcelType& parcel
 162             );
 163
 164             //- Flag to identify whether model fully describes the parcel
 165             virtual bool fullyDescribed() const;
 166
 167             //- Return flag to identify whether or not injection of parcelI is
 168             //  permitted
 169             virtual bool validInjection(const label parcelI);
 170 };
 171
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 } // End namespace Foam
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #ifdef NoRepository
 180 #   include "PatchInjection.C"
 181 #endif
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 #endif
 186
 187 // ************************************************************************* //