ScriptInterface::ReactionMethods::ConstantpHEnsemble Class Reference

#include <ConstantpHEnsemble.hpp>

Inheritance diagram for ScriptInterface::ReactionMethods::ConstantpHEnsemble:

Collaboration diagram for ScriptInterface::ReactionMethods::ConstantpHEnsemble:

Public Member Functions
std::shared_ptr<::ReactionMethods::ReactionAlgorithm >	RE () override
std::shared_ptr<::ReactionMethods::ReactionAlgorithm > const	RE () const override
	ConstantpHEnsemble ()
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
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.
std::string	serialize () const

Protected Member Functions
double	calculate_factorial_expression (::ReactionMethods::SingleReaction const &reaction, std::unordered_map< int, int > const &particle_numbers) const override
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.
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

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::ReactionMethods::ReactionAlgorithm
std::vector< std::shared_ptr< SingleReaction > >	m_reactions
	Keep track of the script interface pointer of each reaction.

Detailed Description

Definition at line 37 of file script_interface/reaction_methods/ConstantpHEnsemble.hpp.

Constructor & Destructor Documentation

ConstantpHEnsemble()

ScriptInterface::ReactionMethods::ConstantpHEnsemble::ConstantpHEnsemble ( )

inline

Definition at line 47 of file script_interface/reaction_methods/ConstantpHEnsemble.hpp.

References ScriptInterface::AutoParameters< ReactionAlgorithm >::add_parameters(), and ScriptInterface::get_value().

Member Function Documentation

calculate_factorial_expression()

double ScriptInterface::ReactionMethods::ConstantpHEnsemble::calculate_factorial_expression ( ::ReactionMethods::SingleReaction const &  reaction, std::unordered_map< int, int > const &  particle_numbers  ) const

inlineoverrideprotectedvirtual

Reimplemented from ScriptInterface::ReactionMethods::ReactionAlgorithm.

Definition at line 73 of file script_interface/reaction_methods/ConstantpHEnsemble.hpp.

References ScriptInterface::get_value().

do_construct()

void ScriptInterface::ReactionMethods::ConstantpHEnsemble::do_construct ( VariantMap const &  params )

inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 57 of file script_interface/reaction_methods/ConstantpHEnsemble.hpp.

References ScriptInterface::ObjectHandle::context(), ScriptInterface::AutoParameters< ReactionAlgorithm >::do_set_parameter(), ScriptInterface::get_value(), ScriptInterface::get_value_or(), ScriptInterface::Context::parallel_try_catch(), and params.

RE() [1/2]

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

inlineoverridevirtual

Implements ScriptInterface::ReactionMethods::ReactionAlgorithm.

Definition at line 43 of file script_interface/reaction_methods/ConstantpHEnsemble.hpp.

RE() [2/2]

std::shared_ptr<::ReactionMethods::ReactionAlgorithm > ScriptInterface::ReactionMethods::ConstantpHEnsemble::RE ( )

inlineoverridevirtual

Implements ScriptInterface::ReactionMethods::ReactionAlgorithm.

Definition at line 39 of file script_interface/reaction_methods/ConstantpHEnsemble.hpp.

---

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

• script_interface/reaction_methods/ConstantpHEnsemble.hpp