Reaktoro 
A unified framework for modeling chemically reactive systems
MineralSpecies.hpp
1 // Reaktoro is a unified framework for modeling chemically reactive systems.
2 //
3 // Copyright (C) 2014-2015 Allan Leal
4 //
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // This program 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
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18 #pragma once
19 
20 // Reaktoro includes
21 #include <Reaktoro/Core/Species.hpp>
22 #include <Reaktoro/Thermodynamics/Species/ThermoData.hpp>
23 
24 namespace Reaktoro {
25 
27 class MineralSpecies : public Species
28 {
29 public:
32 
34  MineralSpecies(const Species& species);
35 
37  auto setThermoData(const MineralSpeciesThermoData& thermo) -> void;
38 
40  auto thermoData() const -> const MineralSpeciesThermoData&;
41 
42 private:
43  struct Impl;
44 
45  std::shared_ptr<Impl> pimpl;
46 };
47 
48 } // namespace Reaktoro
A type used to describe a species and its attributes.
Definition: Species.hpp:41
auto setThermoData(const MineralSpeciesThermoData &thermo) -> void
Set the thermodynamic data of the mineral species.
Definition: MineralSpecies.cpp:36
MineralSpecies()
Construct a default MineralSpecies instance.
Definition: MineralSpecies.cpp:28
A type for storing the thermodynamic data of a mineral species.
Definition: ThermoData.hpp:262
auto thermoData() const -> const MineralSpeciesThermoData &
Return the thermodynamic data of the mineral species.
Definition: MineralSpecies.cpp:41
The namespace containing all components of the Reaktoro library.
Definition: ChemicalScalar.hpp:24
A type to describe the attributes of a mineral species.
Definition: MineralSpecies.hpp:27