applications/solvers/combustion/PDRFoam/XiModels/fixed/fixed.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::XiModels::fixed
  26
  27 Description
  28     Fixed value model for Xi. See \link XiModel.H \endlink for more details
  29     on flame wrinkling modelling.
  30
  31 SourceFiles
  32     fixed.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef fixed_H
  37 #define fixed_H
  38
  39 #include "XiModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace XiModels
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                           Class fixed Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class fixed
  53 :
  54     public XiModel
  55 {
  56     // Private Member Functions
  57
  58         //- Disallow copy construct
  59         fixed(const fixed&);
  60
  61         //- Disallow default bitwise assignment
  62         void operator=(const fixed&);
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("fixed");
  69
  70
  71     // Constructors
  72
  73         //- Construct from components
  74         fixed
  75         (
  76             const dictionary& XiProperties,
  77             const hhuCombustionThermo& thermo,
  78             const compressible::RASModel& turbulence,
  79             const volScalarField& Su,
  80             const volScalarField& rho,
  81             const volScalarField& b,
  82             const surfaceScalarField& phi
  83         );
  84
  85
  86     //- Destructor
  87     virtual ~fixed();
  88
  89
  90     // Member Functions
  91
  92         //- Correct the flame-wrinking Xi
  93         virtual void correct()
  94         {}
  95
  96         //- Update properties from given dictionary
  97         virtual bool read(const dictionary& XiProperties);
  98
  99         //- Write fields of the XiEq model
 100         virtual void writeFields()
 101         {}
 102
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace XiModels
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //