basicCombustionMixture.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) 2014-2021 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::basicCombustionMixture
26 
27 Description
28  Specialisation of the basicMixture for combustion.
29 
30 SourceFiles
31  basicCombustionMixture.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef basicCombustionMixture_H
36 #define basicCombustionMixture_H
37 
38 #include "volFields.H"
39 #include "PtrList.H"
40 #include "basicMixture.H"
41 #include "speciesTable.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class basicCombustionMixture Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public basicMixture
55 {
56 
57 protected:
58 
59  // Protected data
60 
61  //- Table of specie names
63 
64  //- Species mass fractions
66 
67 
68 public:
69 
70  //- Run time type information
71  TypeName("basicCombustionMixture");
72 
73 
74  //- The base class of the mixture
76 
77 
78  // Constructors
79 
80  //- Construct from dictionary, specie names, mesh and phase name
82  (
83  const dictionary&,
84  const wordList& specieNames,
85  const fvMesh&,
86  const word&
87  );
88 
89 
90  //- Destructor
91  virtual ~basicCombustionMixture()
92  {}
93 
94 
95  // Member Functions
96 
97  //- Does the mixture include this specie?
98  inline bool contains(const word& specieName) const;
99 
100  //- Return the mass-fraction field for a specie given by name
101  inline volScalarField& Y(const word& specieName);
102 
103  //- Return the const mass-fraction field for a specie given by name
104  inline const volScalarField& Y(const word& specieName) const;
105 
106  inline scalar fres(const scalar ft, const scalar stoicRatio) const;
107 
109  (
110  const volScalarField& ft,
111  const dimensionedScalar& stoicRatio
112  ) const;
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #include "basicCombustionMixtureI.H"
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
scalar fres(const scalar ft, const scalar stoicRatio) const
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
volScalarField & Y(const word &specieName)
Return the mass-fraction field for a specie given by name.
TypeName("basicCombustionMixture")
Run time type information.
A class for handling words, derived from string.
Definition: word.H:59
Specialisation of the basicMixture for combustion.
Foam::basicMixture.
Definition: basicMixture.H:50
speciesTable species_
Table of specie names.
A wordList with hashed indices for faster lookup by name.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
bool contains(const word &specieName) const
Does the mixture include this specie?
virtual ~basicCombustionMixture()
Destructor.
basicCombustionMixture(const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
Construct from dictionary, specie names, mesh and phase name.
PtrList< volScalarField > Y_
Species mass fractions.
A class for managing temporary objects.
Definition: PtrList.H:53
basicCombustionMixture basicMixtureType
The base class of the mixture.
Namespace for OpenFOAM.