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

#include <EKSpeciesNode.hpp>

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

Public Member Functions

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

Detailed Description

Definition at line 43 of file EKSpeciesNode.hpp.

Constructor & Destructor Documentation

◆ EKSpeciesNode()

ScriptInterface::walberla::EKSpeciesNode::EKSpeciesNode ( )
inline

Member Function Documentation

◆ do_call_method()

Variant ScriptInterface::walberla::EKSpeciesNode::do_call_method ( std::string const &  name,
VariantMap const &  params 
)
overridevirtual

◆ do_construct()

void ScriptInterface::walberla::EKSpeciesNode::do_construct ( VariantMap const &  params)
inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 56 of file EKSpeciesNode.hpp.

References ScriptInterface::LatticeIndices::get_mapped_index(), and params.


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