applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/instabilityXiEq/instabilityXiEq.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::XiEqModels::instability
  27
  28 Description
  29     This is the equilibrium level of the flame wrinkling generated by
  30     instability. It is a constant (default 2.5). It is used in
  31     @link XiModel.H @endlink.
  32
  33 SourceFiles
  34     instability.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef instability_H
  39 #define instability_H
  40
  41 #include "XiEqModel.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace XiEqModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                           Class instability Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class instability
  55 :
  56     public XiEqModel
  57 {
  58     // Private data
  59
  60         //- Equilibrium Xi due to instability only
  61         scalar XiEqIn;
  62
  63         //- Equilibrium Xi model due to all other effects
  64         autoPtr<XiEqModel> XiEqModel_;
  65
  66
  67     // Private Member Functions
  68
  69         //- Disallow copy construct
  70         instability(const instability&);
  71
  72         //- Disallow default bitwise assignment
  73         void operator=(const instability&);
  74
  75
  76 public:
  77
  78     //- Runtime type information
  79     TypeName("instability");
  80
  81
  82     // Constructors
  83
  84         //- Construct from components
  85         instability
  86         (
  87             const dictionary& XiEqProperties,
  88             const hhuCombustionThermo& thermo,
  89             const compressible::RASModel& turbulence,
  90             const volScalarField& Su
  91         );
  92
  93
  94     // Destructor
  95
  96         virtual ~instability();
  97
  98
  99     // Member Functions
 100
 101         //- Return the flame-wrinking XiEq
 102         virtual tmp<volScalarField> XiEq() const;
 103
 104         //- Update properties from given dictionary
 105         virtual bool read(const dictionary& XiEqProperties);
 106 };
 107
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 } // End namespace XiEqModels
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //