Loading [MathJax]/extensions/TeX/AMSmath.js
ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages Concepts
Analysis.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 "ObservableStat.hpp"
23
26
27#include <memory>
28#include <string>
29
30namespace ScriptInterface {
31namespace Analysis {
32
33class Analysis : public System::Leaf {
34 std::shared_ptr<ObservableStat> m_obs_stat;
35
36 /** @brief Check if a particle type exists. */
37 void check_particle_type(int p_type) const;
38
39 void do_construct(VariantMap const &params) override {
40 m_obs_stat = std::make_shared<ObservableStat>();
41 }
42
44 m_obs_stat->bind_system(m_system.lock());
45 }
46
47public:
48 Variant do_call_method(std::string const &name,
49 VariantMap const &parameters) override;
50};
51
52} // namespace Analysis
53} // namespace ScriptInterface
void on_bind_system(::System::System &) override
Definition Analysis.hpp:43
void do_construct(VariantMap const &params) override
Definition Analysis.hpp:39
Variant do_call_method(std::string const &name, VariantMap const &parameters) override
Definition Analysis.cpp:116
boost::string_ref name() const
Script interface wrapper for a component of the system class.
std::weak_ptr<::System::System > m_system
Main system class.
T get_value(Variant const &v)
Extract value of specific type T from a Variant.
std::unordered_map< std::string, Variant > VariantMap
Definition Variant.hpp:69
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
static SteepestDescentParameters params
Currently active steepest descent instance.