src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/ReactingLookupTableInjection.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-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::ReactingLookupTableInjection
  27
  28 Description
  29     Particle injection sources read from look-up table. Each row corresponds to
  30     an injection site.
  31
  32     (
  33         (x y z u v w d rho mDot T cp Y0..YN)
  34     );
  35
  36     where:
  37         x, y, z = global cartesian co-ordinates [m]
  38         u, v, w = global cartesian velocity components [m/s]
  39         d       = diameter [m]
  40         rho     = density [kg/m3]
  41         mDot    = mass flow rate [kg/m3]
  42         T       = temperature [K]
  43         cp      = specific heat capacity [J/kg/K]
  44
  45 SourceFiles
  46     ReactingLookupTableInjection.C
  47
  48 \*---------------------------------------------------------------------------*/
  49
  50 #ifndef ReactingLookupTableInjection_H
  51 #define ReactingLookupTableInjection_H
  52
  53 #include "InjectionModel.H"
  54 #include "pdf.H"
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 namespace Foam
  59 {
  60
  61 /*---------------------------------------------------------------------------*\
  62                 Class ReactingLookupTableInjection Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template<class CloudType>
  66 class ReactingLookupTableInjection
  67 :
  68     public InjectionModel<CloudType>
  69 {
  70     // Private data
  71
  72         //- Name of file containing injector/parcel data
  73         const word inputFileName_;
  74
  75         //- Injection duration - common to all injection sources
  76         const scalar duration_;
  77
  78         //- Number of parcels per injector - common to all injection sources
  79         const label nParcelsPerSecond_;
  80
  81         //- List of parcel position per injector / [m]
  82         List<point> x_;
  83
  84         //- List of parcel velocity per injector / [m]
  85         List<vector> U_;
  86
  87         //- List of parcel diameter per injector / [m]
  88         List<scalar> d_;
  89
  90         //- List of parcel fluid density pre injector / [kg/m3]
  91         List<scalar> rho_;
  92
  93         //- List of parcel injection mass flow per injector / [kg/s]
  94         List<scalar> mDot_;
  95
  96         //- List of parcel temperature flow per injector / [K]
  97         List<scalar> T_;
  98
  99         //- List of parcel specific heat capacity per injector / [J/kg/K]
 100         List<scalar> cp_;
 101
 102         //- List of parcel specie mass fractions per injector / []
 103         List<scalarList> Y_;
 104
 105         //- List of injector cells per injector
 106         List<label> injectorCells_;
 107
 108         //- Number of columns expected in input file
 109         static label INPUT_FILE_COLS;
 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("ReactingLookupTableInjection");
 135
 136
 137     // Constructors
 138
 139         //- Construct from dictionary
 140         ReactingLookupTableInjection
 141         (
 142             const dictionary& dict,
 143             CloudType& owner
 144         );
 145
 146
 147     //- Destructor
 148     virtual ~ReactingLookupTableInjection();
 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 "ReactingLookupTableInjection.C"
 198 #endif
 199
 200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 201
 202 #endif
 203
 204 // ************************************************************************* //