#include <EKSpecies.hpp>

Inheritance diagram for ScriptInterface::walberla::EKSpecies:

Collaboration diagram for ScriptInterface::walberla::EKSpecies:

Public Member Functions
	EKSpecies ()

void	do_construct (VariantMap const &params) override

auto	get_ekinstance () const

auto	get_lattice () const

Variant	do_call_method (std::string const &method, VariantMap const &parameters) override

auto	get_conversion_factor_density () const noexcept

auto	get_conversion_factor_flux () const noexcept

::LatticeModel::units_map	get_latice_to_md_units_conversion () const override

Public Member Functions inherited from ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >
Variant	do_call_method (std::string const &method_name, VariantMap const &params) override

Public Member Functions inherited from ScriptInterface::AutoParameters< Derived, Base >
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 Types
using	Base = LatticeModel<::EKinWalberlaBase, EKVTKHandle >

Protected Member Functions
void	make_instance (VariantMap const &params) override

Protected Member Functions inherited from ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >
auto	find_vtk (std::shared_ptr< EKVTKHandle > const &vtk) const

auto	serialize_vtk_writers () const

Protected Member Functions inherited from ScriptInterface::AutoParameters< Derived, Base >
	AutoParameters ()=default

	AutoParameters (std::vector< AutoParameter > &&params)

void	add_parameters (std::vector< AutoParameter > &&params)

auto const &	get_parameter_insertion_order () const

Protected Attributes
double	m_conv_diffusion

double	m_conv_ext_efield

double	m_conv_energy

double	m_conv_density

double	m_conv_flux

double	m_tau

double	m_density

Protected Attributes inherited from ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >
std::shared_ptr< LatticeWalberla >	m_lattice

std::shared_ptr< ::EKinWalberlaBase >	m_instance

std::vector< std::shared_ptr< EKVTKHandle > >	m_vtk_writers

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 47 of file EKSpecies.hpp.

Member Typedef Documentation

◆ Base

using ScriptInterface::walberla::EKSpecies::Base = LatticeModel<::EKinWalberlaBase, EKVTKHandle>

protected

Definition at line 49 of file EKSpecies.hpp.

Constructor & Destructor Documentation

◆ EKSpecies()

ScriptInterface::walberla::EKSpecies::EKSpecies ( )

inline

Definition at line 61 of file EKSpecies.hpp.

References ScriptInterface::AutoParameters< Derived, Base >::add_parameters(), ScriptInterface::ObjectHandle::context(), ScriptInterface::get_value(), m_conv_density, m_conv_diffusion, m_conv_energy, m_conv_ext_efield, m_density, ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::m_instance, ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::m_lattice, m_tau, ScriptInterface::Context::parallel_try_catch(), ScriptInterface::AutoParameter::read_only, and ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::serialize_vtk_writers().

Member Function Documentation

◆ do_call_method()

Variant ScriptInterface::walberla::EKSpecies::do_call_method	(	std::string const &	method,
		VariantMap const &	parameters
	)

overridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 49 of file EKSpecies.cpp.

References ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::do_call_method(), ScriptInterface::get_value(), and ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::m_instance.

◆ do_construct()

void ScriptInterface::walberla::EKSpecies::do_construct ( VariantMap const & params )

overridevirtual

◆ get_conversion_factor_density()

auto ScriptInterface::walberla::EKSpecies::get_conversion_factor_density ( ) const

inlinenoexcept

Definition at line 140 of file EKSpecies.hpp.

References m_conv_density.

◆ get_conversion_factor_flux()

auto ScriptInterface::walberla::EKSpecies::get_conversion_factor_flux ( ) const

inlinenoexcept

Definition at line 143 of file EKSpecies.hpp.

References m_conv_flux.

◆ get_ekinstance()

auto ScriptInterface::walberla::EKSpecies::get_ekinstance ( ) const

inline

Definition at line 134 of file EKSpecies.hpp.

References ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::m_instance.

◆ get_latice_to_md_units_conversion()

::LatticeModel::units_map ScriptInterface::walberla::EKSpecies::get_latice_to_md_units_conversion ( ) const

inlineoverridevirtual

Implements ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >.

Definition at line 147 of file EKSpecies.hpp.

References m_conv_density, and m_conv_flux.

Referenced by do_construct().

◆ get_lattice()

auto ScriptInterface::walberla::EKSpecies::get_lattice ( ) const

inline

Definition at line 135 of file EKSpecies.hpp.

References ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::m_lattice.

◆ make_instance()

void ScriptInterface::walberla::EKSpecies::make_instance ( VariantMap const & params )

overrideprotectedvirtual

Implements ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >.

Definition at line 91 of file EKSpecies.cpp.

References density, ScriptInterface::get_value(), m_conv_density, m_conv_diffusion, m_conv_energy, m_conv_ext_efield, ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::m_instance, ScriptInterface::walberla::LatticeModel<::EKinWalberlaBase, EKVTKHandle >::m_lattice, walberla::new_ek_walberla(), and params.

Referenced by do_construct().

Member Data Documentation

◆ m_conv_density

double ScriptInterface::walberla::EKSpecies::m_conv_density

protected

Definition at line 53 of file EKSpecies.hpp.

Referenced by do_construct(), EKSpecies(), get_conversion_factor_density(), get_latice_to_md_units_conversion(), and make_instance().

◆ m_conv_diffusion

double ScriptInterface::walberla::EKSpecies::m_conv_diffusion

protected

Definition at line 50 of file EKSpecies.hpp.

Referenced by do_construct(), EKSpecies(), and make_instance().

◆ m_conv_energy

double ScriptInterface::walberla::EKSpecies::m_conv_energy

protected

Definition at line 52 of file EKSpecies.hpp.

Referenced by do_construct(), EKSpecies(), and make_instance().

◆ m_conv_ext_efield

double ScriptInterface::walberla::EKSpecies::m_conv_ext_efield

protected

Definition at line 51 of file EKSpecies.hpp.

Referenced by do_construct(), EKSpecies(), and make_instance().

◆ m_conv_flux

double ScriptInterface::walberla::EKSpecies::m_conv_flux

protected

Definition at line 54 of file EKSpecies.hpp.

Referenced by do_construct(), get_conversion_factor_flux(), and get_latice_to_md_units_conversion().

◆ m_density

double ScriptInterface::walberla::EKSpecies::m_density

protected

Definition at line 56 of file EKSpecies.hpp.

Referenced by do_construct(), and EKSpecies().

◆ m_tau

double ScriptInterface::walberla::EKSpecies::m_tau

protected

Definition at line 55 of file EKSpecies.hpp.

Referenced by do_construct(), and EKSpecies().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ EKSpecies()

Member Function Documentation

◆ do_call_method()

◆ do_construct()

◆ get_conversion_factor_density()

◆ get_conversion_factor_flux()

◆ get_ekinstance()

◆ get_latice_to_md_units_conversion()

◆ get_lattice()

◆ make_instance()

Member Data Documentation

◆ m_conv_density

◆ m_conv_diffusion

◆ m_conv_energy

◆ m_conv_ext_efield

◆ m_conv_flux

◆ m_density

◆ m_tau