applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.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     basicSubGrid
  27
  28 Description
  29     Basic sub-grid obstacle flame-wrinking generation rate coefficient model.
  30     Details supplied by J Puttock 2/7/06.
  31
  32 SourceFiles
  33     basicSubGrid.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef basicSubGrid_H
  38 #define basicSubGrid_H
  39
  40 #include "XiGModel.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace XiGModels
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                           Class basicSubGrid Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class basicSubGrid
  54 :
  55     public XiGModel
  56 {
  57     // Private data
  58
  59         //- Sub-grid generation rate coefficient
  60         scalar k1;
  61
  62         //- Xi generation rate model due to turbulence
  63         autoPtr<XiGModel> XiGModel_;
  64
  65
  66     // Private Member Functions
  67
  68         //- Disallow copy construct
  69         basicSubGrid(const basicSubGrid&);
  70
  71         //- Disallow default bitwise assignment
  72         void operator=(const basicSubGrid&);
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("basicSubGridG");
  79
  80
  81     // Constructors
  82
  83         //- Construct from components
  84         basicSubGrid
  85         (
  86             const dictionary& XiGProperties,
  87             const hhuCombustionThermo& thermo,
  88             const compressible::RASModel& turbulence,
  89             const volScalarField& Su
  90         );
  91
  92
  93     // Destructor
  94
  95         virtual ~basicSubGrid();
  96
  97
  98     // Member Functions
  99
 100         //- Return the flame-wrinking generation rate
 101         virtual tmp<volScalarField> G() const;
 102
 103         //- Return the flame diffusivity
 104         virtual tmp<volScalarField> Db() const;
 105
 106         //- Update properties from given dictionary
 107         virtual bool read(const dictionary& XiGProperties);
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace XiGModels
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //