ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
ReactionField.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#ifdef ELECTROSTATICS
25
26#include "Actor.hpp"
27
29
31
32#include <memory>
33#include <string>
34
35namespace ScriptInterface {
36namespace Coulomb {
37
38class ReactionField : public Actor<ReactionField, ::ReactionField> {
39
40public:
44 [this]() { return actor()->kappa; }},
45 {"epsilon1", AutoParameter::read_only,
46 [this]() { return actor()->epsilon1; }},
47 {"epsilon2", AutoParameter::read_only,
48 [this]() { return actor()->epsilon2; }},
50 [this]() { return actor()->r_cut; }},
51 });
52 }
53
54 void do_construct(VariantMap const &params) override {
56 m_actor = std::make_shared<CoreActorClass>(
57 get_value<double>(params, "prefactor"),
58 get_value<double>(params, "kappa"),
59 get_value<double>(params, "epsilon1"),
60 get_value<double>(params, "epsilon2"),
61 get_value<double>(params, "r_cut"));
62 });
64 }
65};
66
67} // namespace Coulomb
68} // namespace ScriptInterface
69
70#endif // ELECTROSTATICS
void add_parameters(std::vector< AutoParameter > &&params)
virtual void parallel_try_catch(std::function< void()> const &cb) const =0
Common interface for electrostatic actors.
void do_construct(VariantMap const &params) override
Context * context() const
Responsible context.
This file contains the defaults for ESPResSo.
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
Calculate the Reaction Field energy and force for a particle pair , .
static SteepestDescentParameters params
Currently active steepest descent instance.
static constexpr const ReadOnly read_only