FreeFOAM The Cross-Platform CFD Toolkit
Gulder.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) 1991-2010 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
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::XiEqModels::Gulder
26 
27 Description
28  Simple Gulder model for XiEq based on Gulders correlation
29  with a linear correction function to give a plausible profile for XiEq.
30 
31 SourceFiles
32  Gulder.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef Gulder_H
37 #define Gulder_H
38 
39 #include "../XiEqModel/XiEqModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace XiEqModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class Gulder Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class Gulder
53 :
54  public XiEqModel
55 {
56  // Private data
57 
58  scalar XiEqCoef;
59  dimensionedScalar SuMin;
60 
61 
62  // Private Member Functions
63 
64  //- Disallow copy construct
65  Gulder(const Gulder&);
66 
67  //- Disallow default bitwise assignment
68  void operator=(const Gulder&);
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("Gulder");
75 
76 
77  // Constructors
78 
79  //- Construct from components
80  Gulder
81  (
82  const dictionary& XiEqProperties,
85  const volScalarField& Su
86  );
87 
88 
89  // Destructor
90 
91  virtual ~Gulder();
92 
93 
94  // Member Functions
95 
96  //- Return the flame-wrinking XiEq
97  virtual tmp<volScalarField> XiEq() const;
98 
99  //- Update properties from given dictionary
100  virtual bool read(const dictionary& XiEqProperties);
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace XiEqModels
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************ vim: set sw=4 sts=4 et: ************************ //