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