script_interface/observables/ProfileObservable.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2022 The ESPResSo project
 * Copyright (C) 2002,2003,2004,2005,2006,2007,2008,2009,2010
 *   Max-Planck-Institute for Polymer Research, Theory Group
 *
 * This file is part of ESPResSo.
 *
 * ESPResSo is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ESPResSo is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef SCRIPT_INTERFACE_OBSERVABLES_PROFILEOBSERVABLE_HPP
#define SCRIPT_INTERFACE_OBSERVABLES_PROFILEOBSERVABLE_HPP
 
#include "script_interface/auto_parameters/AutoParameters.hpp"
#include "script_interface/observables/Observable.hpp"
 
#include "core/observables/LBVelocityProfile.hpp"
#include "core/observables/ProfileObservable.hpp"
 
#include <algorithm>
#include <cstddef>
#include <iterator>
#include <memory>
#include <string>
#include <vector>
 
namespace ScriptInterface {
namespace Observables {
 
template <typename CoreObs>
class ProfileObservable
    : public AutoParameters<ProfileObservable<CoreObs>, Observable> {
  using Base = AutoParameters<ProfileObservable<CoreObs>, Observable>;
 
public:
  using Base::Base;
  ProfileObservable() {
    this->add_parameters(
        {{"n_x_bins",
          [this](const Variant &v) {
            profile_observable()->n_bins[0] =
                static_cast<std::size_t>(get_value<int>(v));
          },
          [this]() {
            return static_cast<int>(profile_observable()->n_bins[0]);
          }},
         {"n_y_bins",
          [this](const Variant &v) {
            profile_observable()->n_bins[1] =
                static_cast<std::size_t>(get_value<int>(v));
          },
          [this]() {
            return static_cast<int>(profile_observable()->n_bins[1]);
          }},
         {"n_z_bins",
          [this](const Variant &v) {
            profile_observable()->n_bins[2] =
                static_cast<std::size_t>(get_value<int>(v));
          },
          [this]() {
            return static_cast<int>(profile_observable()->n_bins[2]);
          }},
         {"min_x",
          [this](const Variant &v) {
            profile_observable()->limits[0].first = get_value<double>(v);
          },
          [this]() { return profile_observable()->limits[0].first; }},
         {"min_y",
          [this](const Variant &v) {
            profile_observable()->limits[1].first = get_value<double>(v);
          },
          [this]() { return profile_observable()->limits[1].first; }},
         {"min_z",
          [this](const Variant &v) {
            profile_observable()->limits[2].first = get_value<double>(v);
          },
          [this]() { return profile_observable()->limits[2].first; }},
         {"max_x",
          [this](const Variant &v) {
            profile_observable()->limits[0].second = get_value<double>(v);
          },
          [this]() { return profile_observable()->limits[0].second; }},
         {"max_y",
          [this](const Variant &v) {
            profile_observable()->limits[1].second = get_value<double>(v);
          },
          [this]() { return profile_observable()->limits[1].second; }},
         {"max_z",
          [this](const Variant &v) {
            profile_observable()->limits[2].second = get_value<double>(v);
          },
          [this]() { return profile_observable()->limits[2].second; }}});
  }
 
  void construct(VariantMap const &params) override {}
 
  Variant call_method(std::string const &method,
                      VariantMap const &parameters) override {
    if (method == "edges") {
      std::vector<Variant> variant_edges;
      std::ranges::copy(profile_observable()->edges(),
                        std::back_inserter(variant_edges));
      return variant_edges;
    }
    return Base::call_method(method, parameters);
  }
 
  std::shared_ptr<::Observables::ProfileObservable> profile_observable() const {
    return m_observable;
  }
 
  std::shared_ptr<::Observables::Observable> observable() const override {
    return m_observable;
  }
 
private:
  std::shared_ptr<CoreObs> m_observable;
};
 
} /* namespace Observables */
} /* namespace ScriptInterface */
 
#endif