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

#include <ReactionEnsemble.hpp>

+ Inheritance diagram for ScriptInterface::ReactionMethods::ReactionEnsemble:
+ Collaboration diagram for ScriptInterface::ReactionMethods::ReactionEnsemble:

Public Member Functions

std::shared_ptr<::ReactionMethods::ReactionAlgorithmRE () override
 
std::shared_ptr<::ReactionMethods::ReactionAlgorithm > const RE () const override
 
void do_construct (VariantMap const &params) override
 
- Public Member Functions inherited from ScriptInterface::ReactionMethods::ReactionAlgorithm
 ReactionAlgorithm ()
 
Variant do_call_method (std::string const &name, VariantMap const &params) override
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< ReactionAlgorithm >
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
 

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::ReactionMethods::ReactionAlgorithm
int get_reaction_index (int reaction_id) const
 Check reaction id is within the reaction container bounds.
 
virtual double calculate_factorial_expression (::ReactionMethods::SingleReaction const &reaction, std::unordered_map< int, int > const &particle_numbers) const
 
- Protected Member Functions inherited from ScriptInterface::AutoParameters< ReactionAlgorithm >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto const & get_parameter_insertion_order () const
 
- Protected Attributes inherited from ScriptInterface::ReactionMethods::ReactionAlgorithm
std::vector< std::shared_ptr< SingleReaction > > m_reactions
 Keep track of the script interface pointer of each reaction.
 

Detailed Description

Member Function Documentation

◆ do_construct()

◆ RE() [1/2]

std::shared_ptr<::ReactionMethods::ReactionAlgorithm > const ScriptInterface::ReactionMethods::ReactionEnsemble::RE ( ) const
inlineoverridevirtual

◆ RE() [2/2]

std::shared_ptr<::ReactionMethods::ReactionAlgorithm > ScriptInterface::ReactionMethods::ReactionEnsemble::RE ( )
inlineoverridevirtual

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