All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
mixtureFraction.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2013-2020 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::radiationModels::sootModels::mixtureFraction
26 
27 Description
28  This soot model is purely an state model. The amount of soot produced is
29  determined by a single step chemistry as :
30 
31  nuf Fuel + nuOx Ox = nuP P + nuSoot soot
32 
33  nuSoot is prescribed by the user.
34 
35  The single step chemistry used is read from the combustion.
36  The soot is not considered into the thermodynamics of the system and it
37  is not considered as an extra specie in the solver.
38 
39  The spacial distribution is given by the normalization of the first product
40  on the rhs of the reaction by default or it can be added as input.
41 
42  For example in the radiationProperties dictionary set:
43 
44  sootModel mixtureFraction;
45 
46  mixtureFractionCoeffs
47  {
48  nuSoot 0.015;
49  Wsoot 12;
50  mappingField P;
51  }
52 
53 SourceFiles
54  mixtureFraction.C
55 
56 \*---------------------------------------------------------------------------*/
57 
58 #ifndef mixtureFraction_H
59 #define mixtureFraction_H
60 
61 #include "sootModel.H"
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 namespace Foam
66 {
67 namespace radiationModels
68 {
69 namespace sootModels
70 {
71 
72 /*---------------------------------------------------------------------------*\
73  Class mixtureFraction Declaration
74 \*---------------------------------------------------------------------------*/
75 
76 template<class ThermoType>
77 class mixtureFraction
78 :
79  public sootModel
80 {
81  // Private Data
82 
83  //- Soot mass fraction
84  volScalarField soot_;
85 
86  //- Soot model dictionary
87  dictionary coeffsDict_;
88 
89  //- Soot yield
90  scalar nuSoot_;
91 
92  //- Soot molecular weight
93  scalar Wsoot_;
94 
95  //- Maximum soot mass concentration at stoichiometric
96  scalar sootMax_;
97 
98  //- Name of the field mapping the soot
99  word mappingFieldName_;
100 
101  //- Maximum value of the map field
102  scalar mapFieldMax_;
103 
104 
105 public:
106 
107  //- Runtime type information
108  TypeName("mixtureFraction");
109 
110 
111  // Constructors
112 
113  //- Construct from components
115  (
116  const dictionary& dict,
117  const fvMesh& mesh,
118  const word& modelType
119  );
120 
121 
122  //- Destructor
123  virtual ~mixtureFraction();
124 
125 
126  // Member Functions
127 
128  // Access
129 
130  //- Return Ysoot
131  const volScalarField& soot() const
132  {
133  return soot_;
134  }
135 
136  // Edit
137 
138  //- Main update/correction routine
139  virtual void correct();
140 };
141 
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 } // End namespace sootModels
146 } // End namespace radiationModels
147 } // End namespace Foam
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 #ifdef NoRepository
152  #include "mixtureFraction.C"
153 #endif
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #endif
158 
159 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A class for handling words, derived from string.
Definition: word.H:59
mixtureFraction(const dictionary &dict, const fvMesh &mesh, const word &modelType)
Construct from components.
This soot model is purely an state model. The amount of soot produced is determined by a single step ...
virtual void correct()
Main update/correction routine.
TypeName("mixtureFraction")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Base class for soot models.
Definition: sootModel.H:50
const volScalarField & soot() const
Return Ysoot.
const fvMesh & mesh() const
Reference to the mesh.
Definition: sootModel.H:112
Namespace for OpenFOAM.
const dictionary & dict() const
Reference to the dictionary.
Definition: sootModel.H:118