ScriptInterface::walberla::VTKHandleBase< Field > Class Template Reference

#include <VTKHandle.hpp>

Inheritance diagram for ScriptInterface::walberla::VTKHandleBase< Field >:

Collaboration diagram for ScriptInterface::walberla::VTKHandleBase< Field >:

Public Member Functions
	VTKHandleBase ()
void	detach_from_lattice ()
void	attach_to_lattice (std::weak_ptr< Field > field, ::LatticeModel::units_map const &units)
Public Member Functions inherited from ScriptInterface::AutoParameters< VTKHandleBase< Field > >
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
Variant	do_call_method (std::string const &name, VariantMap const &params) override
Protected Member Functions inherited from ScriptInterface::AutoParameters< VTKHandleBase< Field > >
	AutoParameters ()=default
	AutoParameters (std::vector< AutoParameter > &&params)
void	add_parameters (std::vector< AutoParameter > &&params)
auto const &	get_parameter_insertion_order () const

Private Member Functions
virtual std::unordered_map< std::string, int > const &	get_obs_map () const =0
void	do_construct (VariantMap const &params) override

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

template<class Field>
class ScriptInterface::walberla::VTKHandleBase< Field >

Definition at line 46 of file script_interface/walberla/VTKHandle.hpp.

Constructor & Destructor Documentation

VTKHandleBase()

template<class Field >

ScriptInterface::walberla::VTKHandleBase< Field >::VTKHandleBase ( )

inline

Definition at line 112 of file script_interface/walberla/VTKHandle.hpp.

References ScriptInterface::AutoParameters< VTKHandleBase< Field > >::add_parameters(), ScriptInterface::make_unordered_map_of_variants(), and ScriptInterface::AutoParameter::read_only.

Member Function Documentation

attach_to_lattice()

template<class Field >

void ScriptInterface::walberla::VTKHandleBase< Field >::attach_to_lattice ( std::weak_ptr< Field >  field, ::LatticeModel::units_map const &  units  )

inline

Definition at line 198 of file script_interface/walberla/VTKHandle.hpp.

References ScriptInterface::get_value().

detach_from_lattice()

template<class Field >

void ScriptInterface::walberla::VTKHandleBase< Field >::detach_from_lattice ( )

inline

Definition at line 196 of file script_interface/walberla/VTKHandle.hpp.

do_call_method()

template<class Field >

Variant ScriptInterface::walberla::VTKHandleBase< Field >::do_call_method ( std::string const &  name, VariantMap const &  params  )

inlineoverrideprotectedvirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 158 of file script_interface/walberla/VTKHandle.hpp.

References ScriptInterface::ObjectHandle::context(), ScriptInterface::make_vector_of_variants(), ScriptInterface::ObjectHandle::name(), and ScriptInterface::Context::parallel_try_catch().

do_construct()

template<class Field >

void ScriptInterface::walberla::VTKHandleBase< Field >::do_construct ( VariantMap const &  params )

inlineoverrideprivatevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 131 of file script_interface/walberla/VTKHandle.hpp.

References ScriptInterface::ObjectHandle::context(), ScriptInterface::get_value(), ScriptInterface::Context::parallel_try_catch(), and params.

get_obs_map()

template<class Field >

virtual std::unordered_map< std::string, int > const & ScriptInterface::walberla::VTKHandleBase< Field >::get_obs_map ( ) const

privatepure virtual

Implemented in ScriptInterface::walberla::EKVTKHandle, and ScriptInterface::walberla::LBVTKHandle.

References ScriptInterface::walberla::VTKHandleBase< Field >::get_obs_map(), and ScriptInterface::get_value().

Referenced by ScriptInterface::walberla::VTKHandleBase< Field >::get_obs_map().

---

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

• script_interface/walberla/VTKHandle.hpp