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