src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/DispersionRASModel/DispersionRASModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::DispersionRASModel
  27
  28 Description
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #ifndef DispersionRASModel_H
  33 #define DispersionRASModel_H
  34
  35 #include "DispersionModel.H"
  36 #include "RASModel.H"
  37
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                        Class DispersionRASModel Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 template<class CloudType>
  49 class DispersionRASModel
  50 :
  51     public DispersionModel<CloudType>
  52 {
  53 protected:
  54
  55     // Protected data
  56
  57         //- Reference to the compressible turbulence model
  58         const compressible::RASModel& turbulence_;
  59
  60         // Locally cached turbulence fields
  61
  62             //- Turbulence k
  63             const volScalarField* kPtr_;
  64
  65             //- Take ownership of the k field
  66             bool ownK_;
  67
  68             //- Turbulence epsilon
  69             const volScalarField* epsilonPtr_;
  70
  71             //- Take ownership of the epsilon field
  72             bool ownEpsilon_;
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("DispersionRASModel");
  79
  80
  81     // Constructors
  82
  83         //- Construct from components
  84         DispersionRASModel
  85         (
  86             const dictionary& dict,
  87             CloudType& owner
  88         );
  89
  90
  91     //- Destructor
  92     virtual ~DispersionRASModel();
  93
  94
  95     // Member Functions
  96
  97         //- Cache carrier fields
  98         virtual void cacheFields(const bool store);
  99
 100         //- Return const access to the turbulence model
 101         const compressible::RASModel& turbulence() const
 102         {
 103             return turbulence_;
 104         }
 105 };
 106
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 } // End namespace Foam
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #ifdef NoRepository
 115 #   include "DispersionRASModel.C"
 116 #endif
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 #endif
 121
 122 // ************************************************************************* //