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

#include <thermostat.hpp>

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

Public Member Functions

 Thermostat ()
 
Variant do_call_method (std::string const &name, VariantMap const &params) override
 
void do_construct (VariantMap const &params) override
 
void on_bind_system (::System::System &system) override
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< Thermostat, 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
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
 
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
 

Protected Member Functions

template<typename T >
auto make_autoparameter (T Thermostat::*member, char const *name)
 
template<typename T >
void setup_thermostat (std::shared_ptr< T > &thermostat, VariantMap const &params)
 
template<typename T >
void turn_thermostat_off (T &thermostat)
 
void update_global_kT (double old_kT, double new_kT, int thermo_flag)
 
- Protected Member Functions inherited from ScriptInterface::AutoParameters< Thermostat, System::Leaf >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto const & get_parameter_insertion_order () const
 
- Protected Member Functions inherited from ScriptInterface::System::Leaf
auto constget_system () const
 
autoget_system ()
 

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 Attributes inherited from ScriptInterface::System::Leaf
std::weak_ptr<::System::Systemm_system
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Thermostat()

Member Function Documentation

◆ do_call_method()

◆ do_construct()

void ScriptInterface::Thermostat::Thermostat::do_construct ( VariantMap const params)
inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

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

References params.

◆ make_autoparameter()

template<typename T >
auto ScriptInterface::Thermostat::Thermostat::make_autoparameter ( T Thermostat::*  member,
char const name 
)
inlineprotected

◆ on_bind_system()

void ScriptInterface::Thermostat::Thermostat::on_bind_system ( ::System::System system)
inlineoverridevirtual

◆ setup_thermostat()

template<typename T >
void ScriptInterface::Thermostat::Thermostat::setup_thermostat ( std::shared_ptr< T > &  thermostat,
VariantMap const params 
)
inlineprotected

◆ turn_thermostat_off()

template<typename T >
void ScriptInterface::Thermostat::Thermostat::turn_thermostat_off ( T &  thermostat)
inlineprotected

◆ update_global_kT()

void ScriptInterface::Thermostat::Thermostat::update_global_kT ( double  old_kT,
double  new_kT,
int  thermo_flag 
)
inlineprotected

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