Reaktoro
A unified framework for modeling chemically reactive systems
Element.hpp
1 // Reaktoro is a unified framework for modeling chemically reactive systems.
2 //
3 // Copyright (C) 2014-2018 Allan Leal
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with this library. If not, see <http://www.gnu.org/licenses/>.
17 
18 #pragma once
19 
20 // C++ includes
21 #include <memory>
22 #include <string>
23 
24 namespace Reaktoro {
25 
27 class Element
28 {
29 public:
31  Element();
32 
34  auto setName(std::string name) -> void;
35 
37  auto setMolarMass(double value) -> void;
38 
40  auto name() const -> std::string;
41 
43  auto molarMass() const -> double;
44 
45 private:
46  struct Impl;
47 
48  std::shared_ptr<Impl> pimpl;
49 };
50 
52 auto operator<(const Element& lhs, const Element& rhs) -> bool;
53 
55 auto operator==(const Element& lhs, const Element& rhs) -> bool;
56 
57 } // namespace Reaktoro
auto molarMass() const -> double
Return the molar mass of the element (in units of kg/mol)
Definition: Element.cpp:50
Element()
Construct a default Element instance.
Definition: Element.cpp:31
The namespace containing all components of the Reaktoro library.
Definition: ChemicalScalar.hpp:24
auto name() const -> std::string
Return the name of the element.
Definition: Element.cpp:45
auto setMolarMass(double value) -> void
Set the molar mass of the element (in units of kg/mol)
Definition: Element.cpp:40
A type used to define a chemical element and its attributes.
Definition: Element.hpp:28
auto setName(std::string name) -> void
Set the name of the element.
Definition: Element.cpp:35