Reaktoro  v2.11.0
A unified framework for modeling chemically reactive systems
ThermoFunDatabase.hpp
1 // Reaktoro is a unified framework for modeling chemically reactive systems.
2 //
3 // Copyright © 2014-2024 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 // Reaktoro includes
21 #include <Reaktoro/Common/Types.hpp>
22 #include <Reaktoro/Core/Database.hpp>
23 
24 // Forward declaration of ThermoFun classes
25 namespace ThermoFun { class Database; }
26 
27 namespace Reaktoro {
28 
32 {
33 public:
45  static auto withName(const String& name) -> ThermoFunDatabase;
46 
50  static auto fromFile(const String& filepath) -> ThermoFunDatabase;
51 
55  static auto fromFiles(const Strings& filepaths) -> ThermoFunDatabase;
56 
59  static auto fromContents(const String& contents) -> ThermoFunDatabase;
60 
62  static auto disableLogging() -> void;
63 
66 
69  explicit ThermoFunDatabase(const String& name);
70 
72  explicit ThermoFunDatabase(const ThermoFun::Database& db);
73 };
74 
75 } // namespace Reaktoro
The class used to store and retrieve data of chemical species.
Definition: Database.hpp:32
The class used to store and retrieve data of chemical species from ThermoFun databases.
Definition: ThermoFunDatabase.hpp:32
static auto fromFiles(const Strings &filepaths) -> ThermoFunDatabase
Return a ThermoFunDatabase object constructed with given local files.
static auto fromFile(const String &filepath) -> ThermoFunDatabase
Return a ThermoFunDatabase object constructed with a given local file.
ThermoFunDatabase()
Construct a default ThermoFunDatabase object.
ThermoFunDatabase(const String &name)
Construct a ThermoFunDatabase object with given name of embedded database file.
static auto fromContents(const String &contents) -> ThermoFunDatabase
Return a ThermoFunDatabase object constructed with given database text contents.
ThermoFunDatabase(const ThermoFun::Database &db)
Construct a ThermoFunDatabase object with given object of class ThermoFun::Database.
static auto withName(const String &name) -> ThermoFunDatabase
Return a ThermoFunDatabase object constructed with an embedded database file.
static auto disableLogging() -> void
Disable all logs emitted by ThermoFun.
The namespace containing all components of the Reaktoro library.
Definition: Algorithms.hpp:29
std::string String
Convenient alias for std::string.
Definition: Types.hpp:52
std::vector< std::string > Strings
Convenient alias for std::vector<String>.
Definition: Types.hpp:55