ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
ScriptInterface::Thermostat::ThermalizedBond Class Reference

#include <thermostat.hpp>

+ Inheritance diagram for ScriptInterface::Thermostat::ThermalizedBond:
+ Collaboration diagram for ScriptInterface::Thermostat::ThermalizedBond:

Public Member Functions

::ThermostatFlags get_thermo_flag () const final
 
- Public Member Functions inherited from ScriptInterface::Thermostat::Interface<::ThermalizedBondThermostat >
 Interface ()
 
virtual std::optional< double > extract_kT (VariantMap const &params) const
 
auto release_lock ()
 
auto is_activated () const
 
virtual bool is_seed_required () const
 
auto get_rng_seed () const
 
auto get_rng_counter () const
 
void set_rng_seed (Variant const &value)
 
void set_rng_counter (Variant const &value)
 
void do_construct (VariantMap const &params) override
 
void update_and_bind (VariantMap const &params, bool was_active, std::shared_ptr<::System::System > system)
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< Derived, Base >
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::ObjectHandle
 ObjectHandle ()=default
 
 ObjectHandle (ObjectHandle const &)=delete
 
ObjectHandleoperator= (ObjectHandle const &)=delete
 
virtual ~ObjectHandle ()=default
 
boost::string_ref name () const
 
Contextcontext () 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.
 
std::string serialize () const
 

Private Member Functions

std::shared_ptr< CoreThermostat > & get_member_handle (::Thermostat::Thermostat &thermostat) override
 
std::span< std::string_view constget_required_parameters () const override
 

Additional Inherited Members

- Public Types inherited from ScriptInterface::Thermostat::Interface<::ThermalizedBondThermostat >
using CoreThermostat = ::ThermalizedBondThermostat
 
- 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::Thermostat::Interface<::ThermalizedBondThermostat >
void check_lock ()
 
void on_bind_system (::System::System &system) override
 
void on_detach_system (::System::System &system) override
 
void sanity_checks_positive (double value, std::string const &name) const
 
void sanity_checks_positive (Utils::Vector3d const &value, std::string const &name) const
 
virtual bool invalid_rng_state (VariantMap const &params) const
 
auto make_autoparameter (T CoreThermostat::*member, char const *name)
 
auto make_autogamma (T CoreThermostat::*member, char const *name)
 
virtual VariantMap extend_parameters (VariantMap const &parameters) const
 
Variant do_call_method (std::string const &name, VariantMap const &params) override
 
- Protected Member Functions inherited from ScriptInterface::AutoParameters< Derived, Base >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto constget_parameter_insertion_order () const
 
- Protected Attributes inherited from ScriptInterface::Thermostat::Interface<::ThermalizedBondThermostat >
bool is_active
 
std::shared_ptr< CoreThermostatm_handle
 
std::weak_ptr< bool > m_edit_lock
 Basic lock mechanism that follows RAII.
 

Detailed Description

Definition at line 494 of file script_interface/thermostat/thermostat.hpp.

Member Function Documentation

◆ get_member_handle()

std::shared_ptr< CoreThermostat > & ScriptInterface::Thermostat::ThermalizedBond::get_member_handle ( ::Thermostat::Thermostat thermostat)
inlineoverrideprivatevirtual

◆ get_required_parameters()

std::span< std::string_view const > ScriptInterface::Thermostat::ThermalizedBond::get_required_parameters ( ) const
inlineoverrideprivatevirtual

◆ get_thermo_flag()

::ThermostatFlags ScriptInterface::Thermostat::ThermalizedBond::get_thermo_flag ( ) const
inlinefinalvirtual

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