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
28
#include "
core/electrostatics/reaction_field.hpp
"
29
30
#include "
script_interface/get_value.hpp
"
31
32
#include <memory>
33
#include <string>
34
35
namespace
ScriptInterface
{
36
namespace
Coulomb
{
37
38
class
ReactionField
:
public
Actor
<ReactionField, ::ReactionField> {
39
40
public
:
41
ReactionField
() {
42
add_parameters
({
43
{
"kappa"
,
AutoParameter::read_only
,
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; }},
49
{
"r_cut"
,
AutoParameter::read_only
,
50
[
this
]() {
return
actor
()->r_cut; }},
51
});
52
}
53
54
void
do_construct
(
VariantMap
const
&
params
)
override
{
55
context
()->
parallel_try_catch
([&]() {
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
});
63
set_charge_neutrality_tolerance
(
params
);
64
}
65
};
66
67
}
// namespace Coulomb
68
}
// namespace ScriptInterface
69
70
#endif
// ELECTROSTATICS
ScriptInterface::AutoParameters::add_parameters
void add_parameters(std::vector< AutoParameter > &¶ms)
Definition
AutoParameters.hpp:115
ScriptInterface::Context::parallel_try_catch
virtual void parallel_try_catch(std::function< void()> const &cb) const =0
ScriptInterface::Coulomb::Actor
Common interface for electrostatic actors.
Definition
electrostatics/Actor.hpp:45
ScriptInterface::Coulomb::Actor< ReactionField, ::ReactionField >::m_actor
std::shared_ptr< CoreActorClass > m_actor
Definition
electrostatics/Actor.hpp:55
ScriptInterface::Coulomb::Actor< ReactionField, ::ReactionField >::actor
std::shared_ptr< CoreActorClass > actor()
Definition
electrostatics/Actor.hpp:67
ScriptInterface::Coulomb::Actor< ReactionField, ::ReactionField >::set_charge_neutrality_tolerance
void set_charge_neutrality_tolerance(VariantMap const ¶ms)
Definition
electrostatics/Actor.hpp:71
ScriptInterface::Coulomb::ReactionField
Definition
ReactionField.hpp:38
ScriptInterface::Coulomb::ReactionField::do_construct
void do_construct(VariantMap const ¶ms) override
Definition
ReactionField.hpp:54
ScriptInterface::Coulomb::ReactionField::ReactionField
ReactionField()
Definition
ReactionField.hpp:41
ScriptInterface::ObjectHandle::context
Context * context() const
Responsible context.
Definition
ObjectHandle.hpp:58
config.hpp
This file contains the defaults for ESPResSo.
get_value.hpp
Actor.hpp
Coulomb
Definition
electrostatics/actor.hpp:30
ScriptInterface
Definition
script_interface/accumulators/AccumulatorBase.hpp:33
ScriptInterface::get_value
T get_value(Variant const &v)
Extract value of specific type T from a Variant.
Definition
get_value.hpp:400
ScriptInterface::VariantMap
std::unordered_map< std::string, Variant > VariantMap
Definition
Variant.hpp:69
reaction_field.hpp
Calculate the Reaction Field energy and force for a particle pair , .
params
static SteepestDescentParameters params
Currently active steepest descent instance.
Definition
steepest_descent.cpp:44
ScriptInterface::AutoParameter::read_only
static constexpr const ReadOnly read_only
Definition
AutoParameter.hpp:42
src
script_interface
electrostatics
ReactionField.hpp
Generated on Fri Nov 8 2024 02:12:53 for ESPResSo by
1.9.8