specieElementI.H
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) 2016-2018 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 "token.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
31 {}
32 
33 
35 :
36  name_(name),
37  nAtoms_(nAtoms)
38 {}
39 
40 
42 :
43  name_(is),
44  nAtoms_(readLabel(is))
45 {}
46 
47 
48 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
49 
51 {
52  return name_;
53 }
54 
55 
57 {
58  return name_;
59 }
60 
61 
63 {
64  return nAtoms_;
65 }
66 
67 
69 {
70  return nAtoms_;
71 }
72 
73 
74 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
75 
76 inline bool Foam::specieElement::operator==(const specieElement& se) const
77 {
78  return
79  (
80  nAtoms_ == se.nAtoms_
81  && name_ == se.name_
82  );
83 }
84 
85 
86 inline bool Foam::specieElement::operator!=(const specieElement& se) const
87 {
88  return !operator==(se);
89 }
90 
91 
92 // * * * * * * * * * * * * * * * Ostream Operator * * * * * * * * * * * * * //
93 
95 {
96  os << se.name() << token::SPACE << se.nAtoms();
97  return os;
98 }
99 
100 
101 // ************************************************************************* //
bool operator!=(const specieElement &) const
Inequality comparison.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
specieElement()
Construct null.
bool operator==(const specieElement &) const
Equality comparison.
A class for handling words, derived from string.
Definition: word.H:59
const word & name() const
Return the name of the element.
label nAtoms() const
Return the number of atoms of this element in the specie.
label readLabel(Istream &is)
Definition: label.H:64
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Ostream & operator<<(Ostream &, const ensightPart &)