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) 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::KinematicLookupTableInjection
  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   // injector 1
  33         (x y z) (u v w) d rho mDot   // injector 2
  34         ...
  35         (x y z) (u v w) d rho mDot   // injector N
  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
  45 SourceFiles
  46     KinematicLookupTableInjection.C
  47
  48 \*---------------------------------------------------------------------------*/
  49
  50 #ifndef KinematicLookupTableInjection_H
  51 #define KinematicLookupTableInjection_H
  52
  53 #include "InjectionModel.H"
  54 #include "kinematicParcelInjectionDataIOList.H"
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 namespace Foam
  59 {
  60
  61 /*---------------------------------------------------------------------------*\
  62                Class KinematicLookupTableInjection Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template<class CloudType>
  66 class KinematicLookupTableInjection
  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 scalar parcelsPerSecond_;
  80
  81         //- List of injectors
  82         kinematicParcelInjectionDataIOList injectors_;
  83
  84         //- List of cell labels corresponding to injector positions
  85         labelList injectorCells_;
  86
  87         //- List of tetFace labels corresponding to injector positions
  88         labelList injectorTetFaces_;
  89
  90         //- List of tetPt labels corresponding to injector positions
  91         labelList injectorTetPts_;
  92
  93
  94 public:
  95
  96     //- Runtime type information
  97     TypeName("kinematicLookupTableInjection");
  98
  99
 100     // Constructors
 101
 102         //- Construct from dictionary
 103         KinematicLookupTableInjection(const dictionary& dict, CloudType& owner);
 104
 105         //- Construct copy
 106         KinematicLookupTableInjection
 107         (
 108             const KinematicLookupTableInjection<CloudType>& im
 109         );
 110
 111         //- Construct and return a clone
 112         virtual autoPtr<InjectionModel<CloudType> > clone() const
 113         {
 114             return autoPtr<InjectionModel<CloudType> >
 115             (
 116                 new KinematicLookupTableInjection<CloudType>(*this)
 117             );
 118         }
 119
 120
 121     //- Destructor
 122     virtual ~KinematicLookupTableInjection();
 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             //- Set the parcel properties
 152             virtual void setProperties
 153             (
 154                 const label parcelI,
 155                 const label nParcels,
 156                 const scalar time,
 157                 typename CloudType::parcelType& parcel
 158             );
 159
 160             //- Flag to identify whether model fully describes the parcel
 161             virtual bool fullyDescribed() const;
 162
 163             //- Return flag to identify whether or not injection of parcelI is
 164             //  permitted
 165             virtual bool validInjection(const label parcelI);
 166 };
 167
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #ifdef NoRepository
 176 #   include "KinematicLookupTableInjection.C"
 177 #endif
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //