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

#include <EKSpeciesSlice.hpp>

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

Public Member Functions

void do_construct (VariantMap const &params) override
 
Variant do_call_method (std::string const &name, VariantMap const &params) override
 
::LatticeWalberla constget_lattice () const override
 
- 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.
 
virtual std::span< const boost::string_ref > valid_parameters () const
 Get required and optional parameters for class.
 
auto get_valid_parameters () const
 
virtual Variant get_parameter (std::string const &name) const
 Get single parameter.
 
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
 
virtual std::vector< std::pair< std::string, Variant > > serialize_parameters () const
 Serialize parameters.
 

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::walberla::LatticeSlice< EKFieldSerializer >
Variant gather_3d (VariantMap const &params, std::vector< int > const &data_dims, LatticeModel const &lattice_model, std::vector< T >(LatticeModel::*getter)(Utils::Vector3i const &, Utils::Vector3i const &) const, double units_conversion=1.) const
 
void scatter_3d (VariantMap const &params, std::vector< int > const &data_dims, LatticeModel &lattice_model, void(LatticeModel::*setter)(Utils::Vector3i const &, Utils::Vector3i const &, std::vector< T > const &), double units_conversion=1.)
 
- 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 inherited from ScriptInterface::walberla::LatticeSlice< EKFieldSerializer >
Utils::Vector3i m_slice_lower_corner
 
Utils::Vector3i m_slice_upper_corner
 
std::vector< int > m_shape
 

Detailed Description

Definition at line 112 of file EKSpeciesSlice.hpp.

Member Function Documentation

◆ do_call_method()

◆ do_construct()

◆ get_lattice()

::LatticeWalberla const & ScriptInterface::walberla::EKSpeciesSlice::get_lattice ( ) const
inlineoverridevirtual

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