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 held by original author
   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   // injector 1
  34         (x y z) (u v w) d rho mDot   // injector 2
  35         ...
  36         (x y z) (u v w) d rho mDot   // injector N
  37     );
  38
  39     where:
  40         x, y, z = global cartesian co-ordinates [m]
  41         u, v, w = global cartesian velocity components [m/s]
  42         d       = diameter [m]
  43         rho     = density [kg/m3]
  44         mDot    = mass flow rate [kg/m3]
  45
  46 SourceFiles
  47     KinematicLookupTableInjection.C
  48
  49 \*---------------------------------------------------------------------------*/
  50
  51 #ifndef KinematicLookupTableInjection_H
  52 #define KinematicLookupTableInjection_H
  53
  54 #include "InjectionModel.H"
  55 #include "kinematicParcelInjectionDataIOList.H"
  56
  57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  58
  59 namespace Foam
  60 {
  61
  62 /*---------------------------------------------------------------------------*\
  63                Class KinematicLookupTableInjection Declaration
  64 \*---------------------------------------------------------------------------*/
  65
  66 template<class CloudType>
  67 class KinematicLookupTableInjection
  68 :
  69     public InjectionModel<CloudType>
  70 {
  71     // Private data
  72
  73         //- Name of file containing injector/parcel data
  74         const word inputFileName_;
  75
  76         //- Injection duration - common to all injection sources
  77         const scalar duration_;
  78
  79         //- Number of parcels per injector - common to all injection sources
  80         const label nParcelsPerSecond_;
  81
  82         //- List of injectors
  83         kinematicParcelInjectionDataIOList injectors_;
  84
  85         //- List of injector cells per injector
  86         List<label> injectorCells_;
  87
  88
  89 protected:
  90
  91     // Protected member functions
  92
  93         //- Number of parcels to introduce over the time step relative to SOI
  94         label parcelsToInject
  95         (
  96             const scalar time0,
  97             const scalar time1
  98         ) const;
  99
 100         //- Volume of parcels to introduce over the time step relative to SOI
 101         scalar volumeToInject
 102         (
 103             const scalar time0,
 104             const scalar time1
 105         ) const;
 106
 107
 108 public:
 109
 110     //- Runtime type information
 111     TypeName("KinematicLookupTableInjection");
 112
 113
 114     // Constructors
 115
 116         //- Construct from dictionary
 117         KinematicLookupTableInjection
 118         (
 119             const dictionary& dict,
 120             CloudType& owner
 121         );
 122
 123
 124     //- Destructor
 125     virtual ~KinematicLookupTableInjection();
 126
 127
 128     // Member Functions
 129
 130         //- Flag to indicate whether model activates injection model
 131         bool active() const;
 132
 133         //- Return the end-of-injection time
 134         scalar timeEnd() const;
 135
 136
 137         // Injection geometry
 138
 139             //- Set the injection position and owner cell
 140             virtual void setPositionAndCell
 141             (
 142                 const label parcelI,
 143                 const label nParcels,
 144                 const scalar time,
 145                 vector& position,
 146                 label& cellOwner
 147             );
 148
 149             //- Set the parcel properties
 150             virtual void setProperties
 151             (
 152                 const label parcelI,
 153                 const label nParcels,
 154                 const scalar time,
 155                 typename CloudType::parcelType& parcel
 156             );
 157
 158             //- Flag to identify whether model fully describes the parcel
 159             virtual bool fullyDescribed() const;
 160
 161             //- Return flag to identify whether or not injection of parcelI is
 162             //  permitted
 163             virtual bool validInjection(const label parcelI);
 164 };
 165
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 } // End namespace Foam
 170
 171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 172
 173 #ifdef NoRepository
 174 #   include "KinematicLookupTableInjection.C"
 175 #endif
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #endif
 180
 181 // ************************************************************************* //