src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/ReactingMultiphaseLookupTableInjection.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::ReactingMultiphaseLookupTableInjection
  26
  27 Description
  28     Particle injection sources read from look-up table. Each row corresponds to
  29     an injection site.
  30
  31     (
  32        (x y z) (u v w) d rho mDot T cp (Y0..Y2) (Yg0..YgN) (Yl0..YlN) (Ys0..YsN)
  33        (x y z) (u v w) d rho mDot T cp (Y0..Y2) (Yg0..YgN) (Yl0..YlN) (Ys0..YsN)
  34        ...
  35        (x y z) (u v w) d rho mDot T cp (Y0..Y2) (Yg0..YgN) (Yl0..YlN) (Ys0..YsN)
  36     );
  37
  38     where:
  39         x, y, z  = global cartesian co-ordinates [m]
  40         u, v, w  = global cartesian velocity components [m/s]
  41         d        = diameter [m]
  42         rho      = density [kg/m3]
  43         mDot     = mass flow rate [kg/m3]
  44         T        = temperature [K]
  45         cp       = specific heat capacity [J/kg/K]
  46         Y(3)     = total mass fraction of gas (Y0), liquid (Y1), solid (Y3)
  47         Yg(Ngas) = mass fractions of gaseous components
  48         Yl(Nliq) = mass fractions of liquid components
  49         Ys(Nsld) = mass fractions of solid components
  50
  51 SourceFiles
  52     ReactingMultiphaseLookupTableInjection.C
  53
  54 \*---------------------------------------------------------------------------*/
  55
  56 #ifndef ReactingMultiphaseLookupTableInjection_H
  57 #define ReactingMultiphaseLookupTableInjection_H
  58
  59 #include "InjectionModel.H"
  60 #include "reactingMultiphaseParcelInjectionDataIOList.H"
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 namespace Foam
  65 {
  66
  67 /*---------------------------------------------------------------------------*\
  68            Class ReactingMultiphaseLookupTableInjection Declaration
  69 \*---------------------------------------------------------------------------*/
  70
  71 template<class CloudType>
  72 class ReactingMultiphaseLookupTableInjection
  73 :
  74     public InjectionModel<CloudType>
  75 {
  76     // Private data
  77
  78         //- Name of file containing injector/parcel data
  79         const word inputFileName_;
  80
  81         //- Injection duration - common to all injection sources
  82         const scalar duration_;
  83
  84         //- Number of parcels per injector - common to all injection sources
  85         const scalar parcelsPerSecond_;
  86
  87         //- List of injectors
  88         reactingMultiphaseParcelInjectionDataIOList injectors_;
  89
  90         //- List of cell labels corresoponding to injector positions
  91         labelList injectorCells_;
  92
  93         //- List of tetFace labels corresoponding to injector positions
  94         labelList injectorTetFaces_;
  95
  96         //- List of tetPt labels corresoponding to injector positions
  97         labelList injectorTetPts_;
  98
  99
 100 public:
 101
 102     //- Runtime type information
 103     TypeName("reactingMultiphaseLookupTableInjection");
 104
 105
 106     // Constructors
 107
 108         //- Construct from dictionary
 109         ReactingMultiphaseLookupTableInjection
 110         (
 111             const dictionary& dict,
 112             CloudType& owner
 113         );
 114
 115         //- Construct copy
 116         ReactingMultiphaseLookupTableInjection
 117         (
 118             const ReactingMultiphaseLookupTableInjection<CloudType>& im
 119         );
 120
 121         //- Construct and return a clone
 122         virtual autoPtr<InjectionModel<CloudType> > clone() const
 123         {
 124             return autoPtr<InjectionModel<CloudType> >
 125             (
 126                 new ReactingMultiphaseLookupTableInjection<CloudType>(*this)
 127             );
 128         }
 129
 130
 131     //- Destructor
 132     virtual ~ReactingMultiphaseLookupTableInjection();
 133
 134
 135     // Member Functions
 136
 137         //- Return the end-of-injection time
 138         scalar timeEnd() const;
 139
 140         //- Number of parcels to introduce relative to SOI
 141         virtual label parcelsToInject(const scalar time0, const scalar time1);
 142
 143         //- Volume of parcels to introduce relative to SOI
 144         virtual scalar volumeToInject(const scalar time0, const scalar time1);
 145
 146
 147         // Injection geometry
 148
 149             //- Set the injection position and owner cell, tetFace and tetPt
 150             virtual void setPositionAndCell
 151             (
 152                 const label parcelI,
 153                 const label nParcels,
 154                 const scalar time,
 155                 vector& position,
 156                 label& cellOwner,
 157                 label& tetFaceI,
 158                 label& tetPtI
 159             );
 160
 161             //- Set the parcel properties
 162             virtual void setProperties
 163             (
 164                 const label parcelI,
 165                 const label nParcels,
 166                 const scalar time,
 167                 typename CloudType::parcelType& parcel
 168             );
 169
 170             //- Flag to identify whether model fully describes the parcel
 171             virtual bool fullyDescribed() const;
 172
 173             //- Return flag to identify whether or not injection of parcelI is
 174             //  permitted
 175             virtual bool validInjection(const label parcelI);
 176 };
 177
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 } // End namespace Foam
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 #ifdef NoRepository
 186 #   include "ReactingMultiphaseLookupTableInjection.C"
 187 #endif
 188
 189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 190
 191 #endif
 192
 193 // ************************************************************************* //