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) 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::fixed
  27
  28 Description
  29     Fixed value model for Xi. See \link XiModel.H \endlink for more details
  30     on flame wrinkling modelling.
  31
  32 SourceFiles
  33     fixed.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef fixed_H
  38 #define fixed_H
  39
  40 #include "XiModel.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace XiModels
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                           Class fixed Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class fixed
  54 :
  55     public XiModel
  56 {
  57     // Private Member Functions
  58
  59         //- Disallow copy construct
  60         fixed(const fixed&);
  61
  62         //- Disallow default bitwise assignment
  63         void operator=(const fixed&);
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("fixed");
  70
  71
  72     // Constructors
  73
  74         //- Construct from components
  75         fixed
  76         (
  77             const dictionary& XiProperties,
  78             const hhuCombustionThermo& thermo,
  79             const compressible::RASModel& turbulence,
  80             const volScalarField& Su,
  81             const volScalarField& rho,
  82             const volScalarField& b,
  83             const surfaceScalarField& phi
  84         );
  85
  86
  87     // Destructor
  88
  89         virtual ~fixed();
  90
  91
  92     // Member Functions
  93
  94         //- Correct the flame-wrinking Xi
  95         virtual void correct()
  96         {}
  97
  98         //- Update properties from given dictionary
  99         virtual bool read(const dictionary& XiProperties);
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace XiModels
 106 } // End namespace Foam
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 #endif
 111
 112 // ************************************************************************* //