basicCombustionMixture.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2014-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::basicCombustionMixture
28
29Group
30 grpReactionThermophysicalMixtures
31
32Description
33 Specialization of the basicSpecieMixture for combustion.
34
35SourceFiles
36 basicCombustionMixture.C
37
38\*---------------------------------------------------------------------------*/
39
40#ifndef basicCombustionMixture_H
41#define basicCombustionMixture_H
42
43#include "basicSpecieMixture.H"
44
45// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47namespace Foam
48{
49
50/*---------------------------------------------------------------------------*\
51 Class basicCombustionMixture Declaration
52\*---------------------------------------------------------------------------*/
55:
57{
58
59public:
60
61 //- Run time type information
62 TypeName("basicCombustionMixture");
63
64
65 //- The base class of the mixture
67
68
69 // Constructors
70
71 //- Construct from dictionary, specie names, mesh and phase name
73 (
75 const wordList& specieNames,
76 const fvMesh& mesh,
77 const word& phaseName
78 );
79
80
81 //- Destructor
82 virtual ~basicCombustionMixture() = default;
83
84
85 // Member functions
86
87 inline scalar fres(const scalar ft, const scalar stoicRatio) const;
88
90 (
91 const volScalarField& ft,
92 const dimensionedScalar& stoicRatio
93 ) const;
94};
95
96
97// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98
99} // End namespace Foam
100
101// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102
104
105// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106
107#endif
108
109// ************************************************************************* //
Specialization of the basicSpecieMixture for combustion.
TypeName("basicCombustionMixture")
Run time type information.
basicCombustionMixture basicMixtureType
The base class of the mixture.
virtual ~basicCombustionMixture()=default
Destructor.
scalar fres(const scalar ft, const scalar stoicRatio) const
Specialization of basicMultiComponentMixture for a mixture consisting of a number for molecular speci...
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
const dictionary & thermoDict
Definition: EEqn.H:16
dynamicFvMesh & mesh
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73