applications/solvers/combustion/PDRFoam/XiModels/algebraic/algebraic.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::XiModels::algebraic
  27
  28 Description
  29     Simple algebraic model for Xi based on Gulders correlation
  30     with a linear correction function to give a plausible profile for Xi.
  31
  32 SourceFiles
  33     algebraic.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef algebraic_H
  38 #define algebraic_H
  39
  40 #include "XiModel.H"
  41 #include "XiEqModel.H"
  42 #include "XiGModel.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48 namespace XiModels
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                           Class algebraic Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class algebraic
  56 :
  57     public XiModel
  58 {
  59     // Private data
  60
  61         scalar XiShapeCoef;
  62
  63         autoPtr<XiEqModel> XiEqModel_;
  64         autoPtr<XiGModel> XiGModel_;
  65
  66
  67     // Private Member Functions
  68
  69         //- Disallow copy construct
  70         algebraic(const algebraic&);
  71
  72         //- Disallow default bitwise assignment
  73         void operator=(const algebraic&);
  74
  75
  76 public:
  77
  78     //- Runtime type information
  79     TypeName("algebraic");
  80
  81
  82     // Constructors
  83
  84         //- Construct from components
  85         algebraic
  86         (
  87             const dictionary& XiProperties,
  88             const hhuCombustionThermo& thermo,
  89             const compressible::RASModel& turbulence,
  90             const volScalarField& Su,
  91             const volScalarField& rho,
  92             const volScalarField& b,
  93             const surfaceScalarField& phi
  94         );
  95
  96
  97     // Destructor
  98
  99         virtual ~algebraic();
 100
 101
 102     // Member Functions
 103
 104         //- Return the flame diffusivity
 105         virtual tmp<volScalarField> Db() const;
 106
 107         //- Correct the flame-wrinking Xi
 108         virtual void correct();
 109
 110         //- Update properties from given dictionary
 111         virtual bool read(const dictionary& XiProperties);
 112 };
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 } // End namespace XiModels
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //