algebraic.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2012 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::algebraic
26 
27 Description
28  Simple algebraic model for Xi based on Gulders correlation
29  with a linear correction function to give a plausible profile for Xi.
30  See report TR/HGW/10 for details on the Weller two equations model.
31  See \link XiModel.H \endlink for more details on flame wrinkling modelling.
32 
33 SourceFiles
34  algebraic.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef algebraic_H
39 #define algebraic_H
40 
41 #include "XiModel.H"
42 #include "XiEqModel.H"
43 #include "XiGModel.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace XiModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class algebraic Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class algebraic
57 :
58  public XiModel
59 {
60  // Private data
61 
62  scalar XiShapeCoef;
63 
64  autoPtr<XiEqModel> XiEqModel_;
65  autoPtr<XiGModel> XiGModel_;
66 
67 
68  // Private Member Functions
69 
70  //- Disallow copy construct
71  algebraic(const algebraic&);
72 
73  //- Disallow default bitwise assignment
74  void operator=(const algebraic&);
75 
76 
77 public:
78 
79  //- Runtime type information
80  TypeName("algebraic");
81 
82 
83  // Constructors
84 
85  //- Construct from components
86  algebraic
87  (
88  const dictionary& XiProperties,
91  const volScalarField& Su,
92  const volScalarField& rho,
93  const volScalarField& b,
94  const surfaceScalarField& phi
95  );
96 
97 
98  //- Destructor
99  virtual ~algebraic();
100 
101 
102  // Member Functions
103 
104  //- Return the flame diffusivity
105  virtual tmp<volScalarField> Db() const;
106 
107  //- Correct the flame-wrinking Xi
108  virtual void correct();
109 
110  //- Update properties from given dictionary
111  virtual bool read(const dictionary& XiProperties);
112 
113  //- Write fields of the XiEq model
114  virtual void writeFields()
115  {
116  XiEqModel_().writeFields();
117  }
118 
119 };
120 
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 } // End namespace XiModels
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #endif
130 
131 // ************************************************************************* //
autoPtr< compressible::turbulenceModel > turbulence
Definition: createFields.H:23
surfaceScalarField & phi
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Base-class for all Xi models used by the b-Xi combustion model. See Technical Report SH/RE/01R for de...
Definition: XiModel.H:108
Simple algebraic model for Xi based on Gulders correlation with a linear correction function to give ...
Definition: algebraic.H:55
virtual bool read(const dictionary &XiProperties)
Update properties from given dictionary.
virtual tmp< volScalarField > Db() const
Return the flame diffusivity.
const dimensionedScalar b
Wien displacement law constant: default SI units: [m.K].
Definition: createFields.H:27
TypeName("algebraic")
Runtime type information.
Foam::psiuReactionThermo.
Basic thermodynamics type based on the use of fitting functions for cp, h, s obtained from the templa...
RASModel< EddyDiffusivity< turbulenceModel > > RASModel
virtual void writeFields()
Write fields of the XiEq model.
Definition: algebraic.H:113
virtual ~algebraic()
Destructor.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
A class for managing temporary objects.
Definition: PtrList.H:54
tmp< GeometricField< Type, fvPatchField, volMesh > > Su(const GeometricField< Type, fvPatchField, volMesh > &su, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:44
Namespace for OpenFOAM.
virtual void correct()
Correct the flame-wrinking Xi.