ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
DipolarDirectSum.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 DIPOLES
25
26
#include "
Actor.hpp
"
27
28
#include "
core/magnetostatics/dipolar_direct_sum.hpp
"
29
30
#include "
script_interface/get_value.hpp
"
31
32
#include <memory>
33
#include <string>
34
35
namespace
ScriptInterface
{
36
namespace
Dipoles
{
37
38
class
DipolarDirectSum
:
public
Actor
<DipolarDirectSum, ::DipolarDirectSum> {
39
public
:
40
DipolarDirectSum
() {
41
add_parameters
({
42
{
"n_replicas"
,
AutoParameter::read_only
,
43
[
this
]() {
return
actor
()->n_replicas; }},
44
});
45
}
46
47
void
do_construct
(
VariantMap
const
&
params
)
override
{
48
context
()->
parallel_try_catch
([
this
, &
params
]() {
49
m_actor
= std::make_shared<CoreActorClass>(
50
get_value<double>
(
params
,
"prefactor"
),
51
get_value<int>
(
params
,
"n_replicas"
));
52
});
53
}
54
};
55
56
}
// namespace Dipoles
57
}
// namespace ScriptInterface
58
59
#endif
// DIPOLES
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::Dipoles::Actor
Common interface for magnetostatic actors.
Definition
magnetostatics/Actor.hpp:45
ScriptInterface::Dipoles::Actor< DipolarDirectSum, ::DipolarDirectSum >::actor
std::shared_ptr< CoreActorClass > actor()
Definition
magnetostatics/Actor.hpp:71
ScriptInterface::Dipoles::Actor< DipolarDirectSum, ::DipolarDirectSum >::m_actor
std::shared_ptr< CoreActorClass > m_actor
Definition
magnetostatics/Actor.hpp:54
ScriptInterface::Dipoles::DipolarDirectSum
Definition
DipolarDirectSum.hpp:38
ScriptInterface::Dipoles::DipolarDirectSum::do_construct
void do_construct(VariantMap const ¶ms) override
Definition
DipolarDirectSum.hpp:47
ScriptInterface::Dipoles::DipolarDirectSum::DipolarDirectSum
DipolarDirectSum()
Definition
DipolarDirectSum.hpp:40
ScriptInterface::ObjectHandle::context
Context * context() const
Responsible context.
Definition
ObjectHandle.hpp:58
config.hpp
This file contains the defaults for ESPResSo.
dipolar_direct_sum.hpp
get_value.hpp
Actor.hpp
Dipoles
Definition
magnetostatics/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
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
magnetostatics
DipolarDirectSum.hpp
Generated on Fri Nov 22 2024 02:13:55 for ESPResSo by
1.9.8