src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InjectionModel/InjectionModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::InjectionModel
  27
  28
  29 Description
  30     Templated injection model class
  31
  32 SourceFiles
  33     InjectionModel.C
  34     NewInjectionModel.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef InjectionModel_H
  39 #define InjectionModel_H
  40
  41 #include "IOdictionary.H"
  42 #include "autoPtr.H"
  43 #include "runTimeSelectionTables.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                          Class InjectionModel Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class CloudType>
  55 class InjectionModel
  56 {
  57
  58     // Private data
  59
  60         //- The cloud dictionary
  61         const dictionary& dict_;
  62
  63         // Reference to the owner cloud class
  64         CloudType& owner_;
  65
  66         //- The coefficients dictionary
  67         const dictionary coeffDict_;
  68
  69
  70 protected:
  71
  72     // Protected data
  73
  74         // Global injection properties
  75
  76             //- Start of injection [s]
  77             scalar SOI_;
  78
  79             //- Total volume of parcels to introduce [m^3]
  80             //  Initialised in the individual injection models
  81             scalar volumeTotal_;
  82
  83
  84         // Injection properties per Lagrangian time step
  85
  86             //- Time at start of injection time step [s]
  87             scalar timeStep0_;
  88
  89             //- Number of parcels to introduce []
  90             label nParcels_;
  91
  92             //- Volume of parcels to introduce [m^3]
  93             scalar volume_;
  94
  95
  96     // Protected member functions
  97
  98         //- Number of parcels to introduce over the time step
  99         virtual label nParcelsToInject
 100         (
 101             const scalar time0,
 102             const scalar time1
 103         ) const = 0;
 104
 105         //- Volume of parcels to introduce over the time step
 106         virtual scalar volumeToInject
 107         (
 108             const scalar time0,
 109             const scalar time1
 110         ) const = 0;
 111
 112
 113 public:
 114
 115     //- Runtime type information
 116     TypeName("InjectionModel");
 117
 118     //- Declare runtime constructor selection table
 119     declareRunTimeSelectionTable
 120     (
 121         autoPtr,
 122         InjectionModel,
 123         dictionary,
 124         (
 125             const dictionary& dict,
 126             CloudType& owner
 127         ),
 128         (dict, owner)
 129     );
 130
 131
 132     // Constructors
 133
 134         //- Construct from dictionary
 135         InjectionModel
 136         (
 137             const dictionary& dict,
 138             CloudType& owner,
 139             const word& type
 140         );
 141
 142
 143     // Destructor
 144
 145         virtual ~InjectionModel();
 146
 147
 148     // Selector
 149
 150         static autoPtr<InjectionModel<CloudType> > New
 151         (
 152             const dictionary& dict,
 153             CloudType& owner
 154         );
 155
 156
 157     // Access
 158
 159         //- Return const access the owner cloud object
 160         const CloudType& owner() const;
 161
 162         //- Return non-const access the owner cloud object for manipulation
 163         CloudType& owner();
 164
 165         //- Return the dictionary
 166         const dictionary& dict() const;
 167
 168         //- Return the coefficients dictionary
 169         const dictionary& coeffDict() const;
 170
 171
 172     // Member Functions
 173
 174         //- Flag to indicate whether model activates injection model
 175         virtual bool active() const = 0;
 176
 177
 178         // Global information
 179
 180             //- Return the start-of-injection time
 181             scalar timeStart() const;
 182
 183             //- Return the total volume to be injected across the event
 184             scalar volumeTotal() const;
 185
 186             //- Return the end-of-injection time
 187             virtual scalar timeEnd() const = 0;
 188
 189
 190         // Per Lagrangian time step properties
 191
 192             //- Determine properties for next time step/injection interval
 193             void prepareForNextTimeStep
 194             (
 195                 const scalar time0,
 196                 const scalar time1
 197             );
 198
 199             //- Return the number of parcels to introduce
 200             label nParcels() const;
 201
 202             //- Return the volume of parcels to introduce
 203             scalar volume() const;
 204
 205             //- Return the volume fraction to introduce
 206             scalar volumeFraction() const;
 207
 208
 209         // Injection geometry
 210
 211             //- Return the injection position
 212             virtual vector position
 213             (
 214                 const label iParcel,
 215                 const scalar time,
 216                 const polyMeshInfo& meshInfo
 217             ) = 0;
 218
 219             //- Return the velocity of the parcel to introduce at a time
 220             virtual vector velocity
 221             (
 222                 const label iParcel,
 223                 const scalar time,
 224                 const polyMeshInfo& meshInfo
 225             ) = 0;
 226
 227             //- Return the diameter of the parcel to introduce at a time
 228             virtual scalar d0
 229             (
 230                 const label iParcel,
 231                 const scalar time
 232             ) const = 0;
 233 };
 234
 235
 236 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 237
 238 } // End namespace Foam
 239
 240 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 241
 242 #define makeInjectionModel(CloudType)                                         \
 243                                                                               \
 244     defineNamedTemplateTypeNameAndDebug(InjectionModel<CloudType>, 0);        \
 245                                                                               \
 246     defineTemplateRunTimeSelectionTable(InjectionModel<CloudType>, dictionary);
 247
 248
 249 #define makeInjectionModelType(SS, CloudType, ParcelType)                     \
 250                                                                               \
 251     defineNamedTemplateTypeNameAndDebug(SS<CloudType<ParcelType> >, 0);       \
 252                                                                               \
 253     InjectionModel<CloudType<ParcelType> >::                                  \
 254         adddictionaryConstructorToTable<SS<CloudType<ParcelType> > >          \
 255             add##SS##CloudType##ParcelType##ConstructorToTable_;
 256
 257
 258 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 259
 260 #ifdef NoRepository
 261 #   include "InjectionModel.C"
 262 #endif
 263
 264 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 265
 266 #endif
 267
 268 // ************************************************************************* //