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-2023 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 spatial distribution is given by the normalisation 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 class mixtureFraction
77 :
78  public sootModel
79 {
80  // Private Data
81 
82  //- Soot mass fraction
83  volScalarField soot_;
84 
85  //- Soot model dictionary
86  dictionary coeffsDict_;
87 
88  //- Soot yield
89  scalar nuSoot_;
90 
91  //- Soot molecular weight
92  scalar Wsoot_;
93 
94  //- Maximum soot mass concentration at stoichiometric
95  scalar sootMax_;
96 
97  //- Name of the field mapping the soot
98  word mappingFieldName_;
99 
100  //- Maximum value of the map field
101  scalar mapFieldMax_;
102 
103 
104 public:
105 
106  //- Runtime type information
107  TypeName("mixtureFraction");
108 
109 
110  // Constructors
111 
112  //- Construct from components
114  (
115  const dictionary& dict,
116  const fvMesh& mesh,
117  const word& modelType
118  );
119 
120 
121  //- Destructor
122  virtual ~mixtureFraction();
123 
124 
125  // Member Functions
126 
127  // Access
128 
129  //- Return Ysoot
130  const volScalarField& soot() const
131  {
132  return soot_;
133  }
134 
135  // Edit
136 
137  //- Main update/correction routine
138  virtual void correct();
139 };
140 
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 } // End namespace sootModels
145 } // End namespace radiationModels
146 } // End namespace Foam
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 #endif
151 
152 // ************************************************************************* //
Generic GeometricField class.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Base class for soot models.
Definition: sootModel.H:51
const dictionary & dict() const
Reference to the dictionary.
Definition: sootModel.H:118
const fvMesh & mesh() const
Reference to the mesh.
Definition: sootModel.H:112
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.
const volScalarField & soot() const
Return Ysoot.
mixtureFraction(const dictionary &dict, const fvMesh &mesh, const word &modelType)
Construct from components.
TypeName("mixtureFraction")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.