src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/KinematicLookupTableInjection.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::KinematicLookupTableInjection
  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)
  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
  43 SourceFiles
  44     KinematicLookupTableInjection.C
  45
  46 \*---------------------------------------------------------------------------*/
  47
  48 #ifndef KinematicLookupTableInjection_H
  49 #define KinematicLookupTableInjection_H
  50
  51 #include "InjectionModel.H"
  52 #include "pdf.H"
  53
  54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  55
  56 namespace Foam
  57 {
  58
  59 /*---------------------------------------------------------------------------*\
  60                Class KinematicLookupTableInjection Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class CloudType>
  64 class KinematicLookupTableInjection
  65 :
  66     public InjectionModel<CloudType>
  67 {
  68     // Private data
  69
  70         //- Name of file containing injector/parcel data
  71         const word inputFileName_;
  72
  73         //- Injection duration - common to all injection sources
  74         const scalar duration_;
  75
  76         //- Number of parcels per injector - common to all injection sources
  77         const label nParcelsPerSecond_;
  78
  79         //- List of parcel position per injector / [m]
  80         List<point> x_;
  81
  82         //- List of parcel velocity per injector / [m]
  83         List<vector> U_;
  84
  85         //- List of parcel diameter per injector / [m]
  86         List<scalar> d_;
  87
  88         //- List of parcel fluid density pre injector / [kg/m3]
  89         List<scalar> rho_;
  90
  91         //- List of parcel injection mass flow per injector / [kg/s]
  92         List<scalar> mDot_;
  93
  94         //- List of injector cells per injector
  95         List<label> injectorCells_;
  96
  97         //- Number of columns expected in input file
  98         static label INPUT_FILE_COLS;
  99
 100
 101 protected:
 102
 103     // Protected member functions
 104
 105         //- Number of parcels to introduce over the time step relative to SOI
 106         label parcelsToInject
 107         (
 108             const scalar time0,
 109             const scalar time1
 110         ) const;
 111
 112         //- Volume of parcels to introduce over the time step relative to SOI
 113         scalar volumeToInject
 114         (
 115             const scalar time0,
 116             const scalar time1
 117         ) const;
 118
 119
 120 public:
 121
 122     //- Runtime type information
 123     TypeName("KinematicLookupTableInjection");
 124
 125
 126     // Constructors
 127
 128         //- Construct from dictionary
 129         KinematicLookupTableInjection
 130         (
 131             const dictionary& dict,
 132             CloudType& owner
 133         );
 134
 135
 136     //- Destructor
 137     virtual ~KinematicLookupTableInjection();
 138
 139
 140     // Member Functions
 141
 142         //- Flag to indicate whether model activates injection model
 143         bool active() const;
 144
 145         //- Return the end-of-injection time
 146         scalar timeEnd() const;
 147
 148
 149         // Injection geometry
 150
 151             //- Set the injection position and owner cell
 152             virtual void setPositionAndCell
 153             (
 154                 const label parcelI,
 155                 const label nParcels,
 156                 const scalar time,
 157                 vector& position,
 158                 label& cellOwner
 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 "KinematicLookupTableInjection.C"
 187 #endif
 188
 189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 190
 191 #endif
 192
 193 // ************************************************************************* //