src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/NoDispersion/NoDispersion.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::NoDispersion
  27
  28 Description
  29     Place holder for 'none' option
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef NoDispersion_H
  34 #define NoDispersion_H
  35
  36 #include "DispersionModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                        Class NoDispersion Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 template<class CloudType>
  48 class NoDispersion
  49 :
  50     public DispersionModel<CloudType>
  51 {
  52 public:
  53
  54     //- Runtime type information
  55     TypeName("none");
  56
  57
  58     // Constructors
  59
  60         //- Construct from components
  61         NoDispersion
  62         (
  63             const dictionary& dict,
  64             CloudType& owner
  65         );
  66
  67
  68     //- Destructor
  69     virtual ~NoDispersion();
  70
  71
  72     // Member Functions
  73
  74         //- Flag to indicate whether model activates injection model
  75         virtual bool active() const;
  76
  77         //- Cache carrier fields
  78         virtual void cacheFields(const bool store);
  79
  80         //- Update (disperse particles)
  81         virtual vector update
  82         (
  83             const scalar dt,
  84             const label celli,
  85             const vector& U,
  86             const vector& Uc,
  87             vector& UTurb,
  88             scalar& tTurb
  89         );
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace Foam
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 #ifdef NoRepository
 100 #   include "NoDispersion.C"
 101 #endif
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //