CoulombP3M.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2022 The ESPResSo project
 *
 * 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/>.
 */
 
#pragma once
 
#include "config/config.hpp"
 
#ifdef P3M
 
#include "Actor.hpp"
 
#include "core/electrostatics/p3m.hpp"
 
#include "script_interface/get_value.hpp"
 
#include <memory>
#include <string>
 
namespace ScriptInterface {
namespace Coulomb {
 
class CoulombP3M : public Actor<CoulombP3M, ::CoulombP3M> {
  bool m_tune;
 
public:
  CoulombP3M() {
    add_parameters({
        {"alpha_L", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.alpha_L; }},
        {"r_cut_iL", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.r_cut_iL; }},
        {"mesh", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.mesh; }},
        {"mesh_off", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.mesh_off; }},
        {"cao", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.cao; }},
        {"accuracy", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.accuracy; }},
        {"epsilon", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.epsilon; }},
        {"a", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.a; }},
        {"alpha", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.alpha; }},
        {"r_cut", AutoParameter::read_only,
         [this]() { return actor()->p3m.params.r_cut; }},
        {"is_tuned", AutoParameter::read_only,
         [this]() { return actor()->is_tuned(); }},
        {"verbose", AutoParameter::read_only,
         [this]() { return actor()->tune_verbose; }},
        {"timings", AutoParameter::read_only,
         [this]() { return actor()->tune_timings; }},
        {"tune", AutoParameter::read_only, [this]() { return m_tune; }},
        {"check_complex_residuals", AutoParameter::read_only,
         [this]() { return actor()->check_complex_residuals; }},
    });
  }
 
  void do_construct(VariantMap const &params) override {
    m_tune = get_value<bool>(params, "tune");
    context()->parallel_try_catch([&]() {
      auto p3m = P3MParameters{!get_value_or<bool>(params, "is_tuned", !m_tune),
                               get_value<double>(params, "epsilon"),
                               get_value<double>(params, "r_cut"),
                               get_value<Utils::Vector3i>(params, "mesh"),
                               get_value<Utils::Vector3d>(params, "mesh_off"),
                               get_value<int>(params, "cao"),
                               get_value<double>(params, "alpha"),
                               get_value<double>(params, "accuracy")};
      m_actor = std::make_shared<CoreActorClass>(
          std::move(p3m), get_value<double>(params, "prefactor"),
          get_value<int>(params, "timings"), get_value<bool>(params, "verbose"),
          get_value<bool>(params, "check_complex_residuals"));
    });
    set_charge_neutrality_tolerance(params);
  }
};
 
} // namespace Coulomb
} // namespace ScriptInterface
 
#endif // P3M