src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/NoInjection/NoInjection.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::NoInjection
  26
  27 Description
  28     Place holder for 'none' option
  29
  30 SourceFiles
  31     NoInjection.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef NoInjection_H
  36 #define NoInjection_H
  37
  38 #include "InjectionModel.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                        Class NoInjection Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class CloudType>
  50 class NoInjection
  51 :
  52     public InjectionModel<CloudType>
  53 {
  54
  55 public:
  56
  57     //- Runtime type information
  58     TypeName("none");
  59
  60
  61     // Constructors
  62
  63         //- Construct from components
  64         NoInjection(const dictionary&, CloudType&);
  65
  66         //- Construct copy
  67         NoInjection(const NoInjection<CloudType>& im);
  68
  69         //- Construct and return a clone
  70         virtual autoPtr<InjectionModel<CloudType> > clone() const
  71         {
  72             return autoPtr<InjectionModel<CloudType> >
  73             (
  74                 new NoInjection<CloudType>(*this)
  75             );
  76         }
  77
  78
  79     //- Destructor
  80     virtual ~NoInjection();
  81
  82
  83     // Member Functions
  84
  85         //- Flag to indicate whether model activates injection model
  86         bool active() const;
  87
  88         //- Return the end-of-injection time
  89         scalar timeEnd() const;
  90
  91         //- Number of parcels to introduce relative to SOI
  92         virtual label parcelsToInject(const scalar time0, const scalar time1);
  93
  94         //- Volume of parcels to introduce relative to SOI
  95         virtual scalar volumeToInject(const scalar time0, const scalar time1);
  96
  97
  98         // Injection geometry
  99
 100             //- Set the injection position and owner cell, tetFace and tetPt
 101             virtual void setPositionAndCell
 102             (
 103                 const label parcelI,
 104                 const label nParcels,
 105                 const scalar time,
 106                 vector& position,
 107                 label& cellOwner,
 108                 label& tetFaceI,
 109                 label& tetPtI
 110             );
 111
 112             virtual void setProperties
 113             (
 114                 const label parcelI,
 115                 const label nParcels,
 116                 const scalar time,
 117                 typename CloudType::parcelType& parcel
 118             );
 119
 120             //- Flag to identify whether model fully describes the parcel
 121             virtual bool fullyDescribed() const;
 122
 123             //- Return flag to identify whether or not injection of parcelI is
 124             //  permitted
 125             virtual bool validInjection(const label parcelI);
 126 };
 127
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 } // End namespace Foam
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #ifdef NoRepository
 136 #   include "NoInjection.C"
 137 #endif
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #endif
 142
 143 // ************************************************************************* //