specie.C
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) 2011-2023 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 \*---------------------------------------------------------------------------*/
25 
26 #include "specie.H"
27 
28 /* * * * * * * * * * * * * * * public constants * * * * * * * * * * * * * * */
29 
30 namespace Foam
31 {
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 :
40  name_(name),
41  Y_(dict.subDict("specie").lookupOrDefault("massFraction", 1.0)),
42  molWeight_(dict.subDict("specie").lookup<scalar>("molWeight"))
43 {}
44 
45 
46 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
47 
49 {
50  dictionary dict("specie");
51  if (Y_ != 1)
52  {
53  dict.add("massFraction", Y_);
54  }
55  dict.add("molWeight", molWeight_);
56  os << indent << dict.dictName() << dict;
57 }
58 
59 
60 // * * * * * * * * * * * * * * * Ostream Operator * * * * * * * * * * * * * //
61 
63 {
64  st.write(os);
65  os.check("Ostream& operator<<(Ostream& os, const specie& st)");
66  return os;
67 }
68 
69 
70 // ************************************************************************* //
virtual bool check(const char *operation) const
Check IOstream status for given operation.
Definition: IOstream.C:92
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
const word dictName() const
Return the local dictionary name (final part of scoped name)
Definition: dictionary.H:123
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
bool add(entry *, bool mergeEntry=false)
Add a new entry.
Definition: dictionary.C:1014
Base class of the thermophysical property types.
Definition: specie.H:66
specie(const scalar Y, const scalar molWeight)
Construct from components without name.
Definition: specieI.H:49
void write(Ostream &os) const
Write to Ostream.
Definition: specie.C:48
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
defineTypeNameAndDebug(combustionModel, 0)
Ostream & operator<<(Ostream &os, const fvConstraints &constraints)
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:227
dictionary dict