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
applications
utilities
thermophysical
mixtureAdiabaticFlameT
substance.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::substance
26
27
Description
28
29
SourceFiles
30
substanceI.H
31
substance.C
32
substanceIO.C
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef substance_H
37
#define substance_H
38
39
#include <
OpenFOAM/scalar.H
>
40
#include <
OpenFOAM/word.H
>
41
#include <
OpenFOAM/Istream.H
>
42
43
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45
namespace
Foam
46
{
47
48
/*---------------------------------------------------------------------------*\
49
Class substance Declaration
50
\*---------------------------------------------------------------------------*/
51
52
class
substance
53
{
54
// Private data
55
56
word
name_;
57
scalar volFrac_;
58
59
60
public
:
61
62
// Constructors
63
64
//- Construct null
65
substance
()
66
{}
67
68
69
// Member Functions
70
71
// Access
72
73
const
word
&
name
()
const
74
{
75
return
name_;
76
}
77
78
scalar
volFrac
()
const
79
{
80
return
volFrac_;
81
}
82
83
bool
operator==
(
const
substance
& s)
const
84
{
85
return
name_ == s.name_ && volFrac_ == s.volFrac_;
86
}
87
88
bool
operator!=
(
const
substance
& s)
const
89
{
90
return
!
operator==
(s);
91
}
92
93
94
// IOstream Operators
95
96
friend
Istream
&
operator>>
(
Istream
& is,
substance
& s)
97
{
98
is >> s.name_ >> s.volFrac_;
99
return
is;
100
}
101
102
friend
Ostream
&
operator<<
(
Ostream
& os,
const
substance
& s)
103
{
104
os << s.name_ <<
token::SPACE
<< s.volFrac_;
105
return
os;
106
}
107
};
108
109
110
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111
112
}
// End namespace Foam
113
114
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115
116
#endif
117
118
// ************************ vim: set sw=4 sts=4 et: ************************ //