OpenFOAM: API Guide
v2112
The open source CFD toolbox
thirdBodyEfficiencies.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) 2011-2017 OpenFOAM Foundation
9
-------------------------------------------------------------------------------
10
License
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
26
Class
27
Foam::thirdBodyEfficiencies
28
29
Description
30
Third body efficiencies
31
32
SourceFiles
33
thirdBodyEfficienciesI.H
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef thirdBodyEfficiencies_H
38
#define thirdBodyEfficiencies_H
39
40
#include "
scalarList.H
"
41
#include "
speciesTable.H
"
42
43
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45
namespace
Foam
46
{
47
48
// Forward declaration of friend functions and operators
49
50
class
thirdBodyEfficiencies;
51
Ostream&
operator<<
(Ostream&,
const
thirdBodyEfficiencies&);
52
53
54
/*---------------------------------------------------------------------------*\
55
Class thirdBodyEfficiencies Declaration
56
\*---------------------------------------------------------------------------*/
57
58
class
thirdBodyEfficiencies
59
:
60
public
scalarList
61
{
62
// Private data
63
64
const
speciesTable
& species_;
65
66
67
public
:
68
69
// Constructors
70
71
//- Construct from components
72
inline
thirdBodyEfficiencies
73
(
74
const
speciesTable
& species,
75
const
scalarList
& efficiencies
76
);
77
78
//- Construct from dictionary
79
inline
thirdBodyEfficiencies
80
(
81
const
speciesTable
& species,
82
const
dictionary
&
dict
83
);
84
85
86
// Member functions
87
88
//- Calculate and return M, the concentration of the third-bodies
89
inline
scalar
M
(
const
scalarList
& c)
const
;
90
91
//- Write to stream
92
inline
void
write
(
Ostream
&
os
)
const
;
93
94
95
96
// Ostream Operator
97
98
friend
Ostream
&
operator<<
(
Ostream
&,
const
thirdBodyEfficiencies
&);
99
};
100
101
102
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103
104
}
// End namespace Foam
105
106
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107
108
#include "
thirdBodyEfficienciesI.H
"
109
110
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111
112
#endif
113
114
// ************************************************************************* //
M
#define M(I)
Foam::List< scalar >
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition:
Ostream.H:62
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:126
Foam::hashedWordList
A wordList with hashed named lookup, which can be faster in some situations than using the normal lis...
Definition:
hashedWordList.H:57
Foam::thirdBodyEfficiencies
Third body efficiencies.
Definition:
thirdBodyEfficiencies.H:60
Foam::thirdBodyEfficiencies::operator<<
friend Ostream & operator<<(Ostream &, const thirdBodyEfficiencies &)
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:34
Foam::operator<<
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
Definition:
boundaryPatch.C:83
write
runTime write()
scalarList.H
dict
dictionary dict
Definition:
searchingEngine.H:14
speciesTable.H
thirdBodyEfficienciesI.H
src
thermophysicalModels
specie
reaction
reactionRate
thirdBodyEfficiencies
thirdBodyEfficiencies.H
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.