ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
StokesianDynamics.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 ESPRESSO_STOKESIAN_DYNAMICS
25
26
#include "
Integrator.hpp
"
27
28
#include "
script_interface/ScriptInterface.hpp
"
29
#include "
script_interface/auto_parameters/AutoParameters.hpp
"
30
31
#include "
core/stokesian_dynamics/sd_interface.hpp
"
32
33
#include <memory>
34
#include <string>
35
36
namespace
ScriptInterface
{
37
namespace
Integrators {
38
39
class
StokesianDynamics
:
public
AutoParameters
<StokesianDynamics, Integrator> {
40
std::shared_ptr<::StokesianDynamicsParameters> m_instance;
41
42
public
:
43
StokesianDynamics
();
44
45
void
do_construct
(
VariantMap
const
&
params
)
override
;
46
void
activate
()
override
;
47
48
::StokesianDynamicsParameters
const
&
get_instance
()
const
{
49
return
*m_instance;
50
}
51
};
52
53
}
// namespace Integrators
54
}
// namespace ScriptInterface
55
56
#endif
// ESPRESSO_STOKESIAN_DYNAMICS
AutoParameters.hpp
Integrator.hpp
ScriptInterface.hpp
ScriptInterface::AutoParameters
Bind parameters in the script interface.
Definition
AutoParameters.hpp:94
ScriptInterface::Integrators::StokesianDynamics
Definition
StokesianDynamics.hpp:39
ScriptInterface::Integrators::StokesianDynamics::StokesianDynamics
StokesianDynamics()
Definition
StokesianDynamics.cpp:39
ScriptInterface::Integrators::StokesianDynamics::activate
void activate() override
Definition
StokesianDynamics.cpp:93
ScriptInterface::Integrators::StokesianDynamics::get_instance
::StokesianDynamicsParameters const & get_instance() const
Definition
StokesianDynamics.hpp:48
ScriptInterface::Integrators::StokesianDynamics::do_construct
void do_construct(VariantMap const ¶ms) override
Definition
StokesianDynamics.cpp:71
config.hpp
ScriptInterface
Definition
script_interface/accumulators/AccumulatorBase.hpp:33
ScriptInterface::VariantMap
std::unordered_map< std::string, Variant > VariantMap
Definition
Variant.hpp:133
sd_interface.hpp
See for the Stokesian dynamics method used here.
params
static SteepestDescentParameters params
Currently active steepest descent instance.
Definition
steepest_descent.cpp:44
StokesianDynamicsParameters
Definition
sd_interface.hpp:53
src
script_interface
integrators
StokesianDynamics.hpp
Generated on Tue Dec 9 2025 02:28:53 for ESPResSo by
1.9.8