Reaktoro  v2.13.0
A unified framework for modeling chemically reactive systems
Params.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/Data.hpp>
23 
24 namespace Reaktoro {
25 
28 class Params
29 {
30 public:
32  Params();
33 
35  Params(Data const& params);
36 
40  static auto fromFile(String const& path) -> Params;
41 
45  static auto fromEmbeddedFile(String const& path) -> Params;
46 
49  static auto fromStringYAML(String const& text) -> Params;
50 
53  static auto fromStringJSON(String const& text) -> Params;
54 
56  static auto embedded(String const& path) -> Params;
57 
59  static auto local(String const& path) -> Params;
60 
62  auto data() const -> Data const&;
63 
65  auto append(Params const& other) -> Params&;
66 
68  auto append(Data const& other) -> Params&;
69 
71  auto operator+=(Params const& other) -> Params&;
72 
74  auto operator[](String const& name) const -> Data const&;
75 
76 private:
78  Data m_data;
79 };
80 
81 } // namespace Reaktoro
The class used to store and retrieve data for assemblying chemical systems.
Definition: Data.hpp:30
Used to store and retrieve model parameters.
Definition: Params.hpp:29
auto append(Params const &other) -> Params &
Append another Params object into this.
static auto fromFile(String const &path) -> Params
Return a Params object constructed with a given local file.
Params(Data const &params)
Construct a Params object with given parameters as Data object.
static auto fromEmbeddedFile(String const &path) -> Params
Return a Params object constructed with a given embedded file.
Params()
Construct a default Params object.
static auto embedded(String const &path) -> Params
Return parameters with the given file path within the virtual directory of embedded resources (equiva...
auto data() const -> Data const &
Return the underlying Data object of this Params object.
static auto local(String const &path) -> Params
Return parameters with the given local file path (equivalent to fromFile).
static auto fromStringJSON(String const &text) -> Params
Return a Params object constructed with given parameters text contents in JSON format.
static auto fromStringYAML(String const &text) -> Params
Return a Params object constructed with given parameters text contents in YAML format.
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