Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
thermophysicalModels
reactionThermo
mixtures
basicMultiComponentMixture
basicMultiComponentMixture.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::basicMultiComponentMixture
26
27
Description
28
combustion mixture
29
30
SourceFiles
31
basicMultiComponentMixture.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef basicMultiComponentMixture_H
36
#define basicMultiComponentMixture_H
37
38
#include <
finiteVolume/volFields.H
>
39
#include <
OpenFOAM/PtrList.H
>
40
#include <
specie/speciesTable.H
>
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
47
/*---------------------------------------------------------------------------*\
48
Class basicMultiComponentMixture Declaration
49
\*---------------------------------------------------------------------------*/
50
51
class
basicMultiComponentMixture
52
{
53
54
protected
:
55
56
// Protected data
57
58
//- Table of specie names
59
speciesTable
species_
;
60
61
//- Species mass fractions
62
PtrList<volScalarField>
Y_
;
63
64
65
public
:
66
67
// Constructors
68
69
//- Construct from dictionary and mesh
70
basicMultiComponentMixture
71
(
72
const
dictionary
&,
73
const
wordList
& specieNames,
74
const
fvMesh
&
75
);
76
77
78
//- Destructor
79
virtual
~basicMultiComponentMixture
()
80
{}
81
82
83
// Member functions
84
85
//- Return the table of species
86
const
speciesTable
&
species
()
const
87
{
88
return
species_
;
89
}
90
91
//- Return the mass-fraction fields
92
inline
PtrList<volScalarField>
&
Y
();
93
94
//- Return the const mass-fraction fields
95
inline
const
PtrList<volScalarField>
&
Y
()
const
;
96
97
//- Return the mass-fraction field for a specie given by index
98
inline
volScalarField
&
Y
(
const
label i);
99
100
//- Return the const mass-fraction field for a specie given by index
101
inline
const
volScalarField
&
Y
(
const
label i)
const
;
102
103
//- Return the mass-fraction field for a specie given by name
104
inline
volScalarField
&
Y
(
const
word
& specieName);
105
106
//- Return the const mass-fraction field for a specie given by name
107
inline
const
volScalarField
&
Y
(
const
word
& specieName)
const
;
108
109
//- Does the mixture include this specie?
110
inline
bool
contains
(
const
word
& specieName)
const
;
111
112
inline
scalar
fres
(
const
scalar
ft
,
const
scalar
stoicRatio
)
const
;
113
114
inline
tmp<volScalarField>
fres
115
(
116
const
volScalarField
&
ft
,
117
const
dimensionedScalar
&
stoicRatio
118
)
const
;
119
};
120
121
122
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123
124
}
// End namespace Foam
125
126
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127
128
#include "
basicMultiComponentMixtureI.H
"
129
130
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131
132
#endif
133
134
// ************************ vim: set sw=4 sts=4 et: ************************ //