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