ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | List of all members
ScriptInterface::Integrators::IntegratorHandle Class Reference

#include <IntegratorHandle.hpp>

+ Inheritance diagram for ScriptInterface::Integrators::IntegratorHandle:
+ Collaboration diagram for ScriptInterface::Integrators::IntegratorHandle:

Public Member Functions

 IntegratorHandle ()
 
void do_construct (VariantMap const &params) override
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< IntegratorHandle, System::Leaf >
std::span< const boost::string_ref > valid_parameters () const final
 
Variant get_parameter (const std::string &name) const final
 
void do_set_parameter (const std::string &name, const Variant &value) final
 
std::vector< std::pair< std::string, Variant > > serialize_parameters () const final
 
- Public Member Functions inherited from ScriptInterface::System::Leaf
 ~Leaf () override=default
 
void bind_system (std::shared_ptr<::System::System > const &system)
 
void detach_system ()
 
- Public Member Functions inherited from ScriptInterface::ObjectHandle
 ObjectHandle ()=default
 
 ObjectHandle (ObjectHandle const &)=delete
 
ObjectHandle & operator= (ObjectHandle const &)=delete
 
virtual ~ObjectHandle ()=default
 
boost::string_ref name () const
 
Context * context () const
 Responsible context.
 
void construct (VariantMap const &params)
 Construct the handled object.
 
VariantMap get_parameters () const
 Get current parameters.
 
auto get_valid_parameters () const
 
void set_parameter (const std::string &name, const Variant &value)
 Set single parameter.
 
Variant call_method (const std::string &name, const VariantMap &params)
 Call a method on the object.
 
virtual Variant do_call_method (const std::string &, const VariantMap &)
 Local implementation of call_method.
 
std::string serialize () const
 

Private Member Functions

void on_bind_system (::System::System &system) override
 

Additional Inherited Members

- Static Public Member Functions inherited from ScriptInterface::ObjectHandle
static ObjectRef deserialize (const std::string &state, Context &ctx)
 Make object from serialized state.
 
- Protected Member Functions inherited from ScriptInterface::AutoParameters< IntegratorHandle, System::Leaf >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
 ~AutoParameters () override=default
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto const & get_parameter_insertion_order () const
 
- Protected Member Functions inherited from ScriptInterface::System::Leaf
auto const & get_system () const
 
auto & get_system ()
 
- Protected Attributes inherited from ScriptInterface::System::Leaf
std::weak_ptr<::System::System > m_system
 

Detailed Description

Definition at line 34 of file IntegratorHandle.hpp.

Constructor & Destructor Documentation

◆ IntegratorHandle()

ScriptInterface::Integrators::IntegratorHandle::IntegratorHandle ( )

Definition at line 40 of file IntegratorHandle.cpp.

References ScriptInterface::AutoParameters< IntegratorHandle, System::Leaf >::add_parameters(), ScriptInterface::ObjectHandle::context(), ScriptInterface::System::Leaf::get_system(), ScriptInterface::get_value(), INTEG_METHOD_BD, INTEG_METHOD_NPT_ISO, INTEG_METHOD_SD, INTEG_METHOD_STEEPEST_DESCENT, ScriptInterface::System::Leaf::m_system, and ScriptInterface::Context::parallel_try_catch().

Member Function Documentation

◆ do_construct()

void ScriptInterface::Integrators::IntegratorHandle::do_construct ( VariantMap const &  params)
inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 43 of file IntegratorHandle.hpp.

References params.

◆ on_bind_system()

void ScriptInterface::Integrators::IntegratorHandle::on_bind_system ( ::System::System &  system)
overrideprivatevirtual

Reimplemented from ScriptInterface::System::Leaf.

Definition at line 96 of file IntegratorHandle.cpp.

References ScriptInterface::ObjectHandle::context(), ScriptInterface::AutoParameters< IntegratorHandle, System::Leaf >::do_set_parameter(), ScriptInterface::AutoParameters< IntegratorHandle, System::Leaf >::get_parameter_insertion_order(), ScriptInterface::get_value(), INTEG_METHOD_NVT, params, and ScriptInterface::ObjectHandle::set_parameter().

The documentation for this class was generated from the following files: