ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
script_interface/scafacos/scafacos.hpp
Go to the documentation of this file.
1/*
2 * Copyright (C) 2022 The ESPResSo project
3 *
4 * This file is part of ESPResSo.
5 *
6 * ESPResSo is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * ESPResSo is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#pragma once
21
22#include "config/config.hpp"
23
24#if defined(SCAFACOS) or defined(SCAFACOS_DIPOLAR)
25
27
28#include <string>
29#include <unordered_map>
30#include <vector>
31
32namespace ScriptInterface {
33namespace Scafacos {
34
35/** @brief Fetch list of methods compiled in ScaFaCoS. */
36std::vector<std::string> available_methods();
37
38/** @brief Flatten a parameter map. */
39std::string serialize_parameters(Variant const &pack);
40
41/** @brief Convert flattened parameters to a map. */
42std::unordered_map<std::string, Variant>
43deserialize_parameters(std::string const &parameters);
44
45} // namespace Scafacos
46} // namespace ScriptInterface
47
48#endif // SCAFACOS or SCAFACOS_DIPOLAR
This file contains the defaults for ESPResSo.
std::unordered_map< std::string, Variant > deserialize_parameters(std::string const &parameters)
Convert flattened parameters to a map.
Definition scafacos.cpp:150
std::string serialize_parameters(Variant const &pack)
Flatten a parameter map.
Definition scafacos.cpp:121
std::vector< std::string > available_methods()
Fetch list of methods compiled in ScaFaCoS.
Definition scafacos.cpp:49
PackedVariant pack(const Variant &v)
Transform a Variant to a PackedVariant.
T get_value(Variant const &v)
Extract value of specific type T from a Variant.
boost::make_recursive_variant< None, bool, int, std::size_t, double, std::string, ObjectRef, Utils::Vector3b, Utils::Vector3i, Utils::Vector2d, Utils::Vector3d, Utils::Vector4d, std::vector< int >, std::vector< double >, std::vector< boost::recursive_variant_ >, std::unordered_map< int, boost::recursive_variant_ >, std::unordered_map< std::string, boost::recursive_variant_ > >::type Variant
Possible types for parameters.
Definition Variant.hpp:67