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