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

#include <EKReaction.hpp>

+ Inheritance diagram for ScriptInterface::walberla::EKReaction:
+ Collaboration diagram for ScriptInterface::walberla::EKReaction:

Public Member Functions

std::shared_ptr<::walberla::EKReactionBaseget_instance () const
 
auto get_conversion_coefficient () const noexcept
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< EKReaction, LatticeIndices >
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.
 
virtual void do_construct (VariantMap const &params)
 
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
 

Protected Member Functions

auto get_agrid (VariantMap const &args) const
 
auto calculate_bulk_conversion_factor (VariantMap const &args) const
 
template<typename F >
auto make_instance (VariantMap const &args, F &allocator) const
 
- Protected Member Functions inherited from ScriptInterface::AutoParameters< EKReaction, LatticeIndices >
 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::LatticeIndices
bool is_index_valid (Utils::Vector3i const &index, Utils::Vector3i const &shape) const
 
void throw_invalid_index (Utils::Vector3i const &index, Utils::Vector3i const &shape) const
 
Utils::Vector3i get_mapped_index (Utils::Vector3i const &index, Utils::Vector3i const &shape) const
 

Protected Attributes

std::shared_ptr<::walberla::EKReactionBasem_ekreaction
 
double m_conv_coefficient
 

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.
 

Detailed Description

Definition at line 48 of file EKReaction.hpp.

Member Function Documentation

◆ calculate_bulk_conversion_factor()

auto ScriptInterface::walberla::EKReaction::calculate_bulk_conversion_factor ( VariantMap const args) const
inlineprotected

◆ get_agrid()

auto ScriptInterface::walberla::EKReaction::get_agrid ( VariantMap const args) const
inlineprotected

◆ get_conversion_coefficient()

auto ScriptInterface::walberla::EKReaction::get_conversion_coefficient ( ) const
inlinenoexcept

◆ get_instance()

◆ make_instance()

template<typename F >
auto ScriptInterface::walberla::EKReaction::make_instance ( VariantMap const args,
F allocator 
) const
inlineprotected

Member Data Documentation

◆ m_conv_coefficient

double ScriptInterface::walberla::EKReaction::m_conv_coefficient
protected

◆ m_ekreaction

std::shared_ptr<::walberla::EKReactionBase> ScriptInterface::walberla::EKReaction::m_ekreaction
protected

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