#include <LBFluid.hpp>

Inheritance diagram for ScriptInterface::walberla::LBFluid:

Collaboration diagram for ScriptInterface::walberla::LBFluid:

Public Member Functions
	LBFluid ()

void	do_construct (VariantMap const &params) override

Variant	do_call_method (std::string const &name, VariantMap const &params) override

auto	get_lb_fluid () const

auto	get_lb_params () const

::LatticeModel::units_map	get_latice_to_md_units_conversion () const 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<::LBWalberlaBase, LBVTKHandle >

Protected Attributes
std::shared_ptr<::LB::LBWalberlaParams >	m_lb_params

bool	m_is_active

double	m_conv_dist

double	m_conv_visc

double	m_conv_dens

double	m_conv_speed

double	m_conv_press

double	m_conv_force

double	m_conv_force_dens

double	m_conv_energy

Protected Attributes inherited from ScriptInterface::walberla::LatticeModel<::LBWalberlaBase, LBVTKHandle >
std::shared_ptr< LatticeWalberla >	m_lattice

std::shared_ptr< ::LBWalberlaBase >	m_instance

std::vector< std::shared_ptr< LBVTKHandle > >	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.

Protected Member Functions inherited from ScriptInterface::walberla::LatticeModel<::LBWalberlaBase, LBVTKHandle >
virtual void	make_instance (VariantMap const &params)=0

auto	find_vtk (std::shared_ptr< LBVTKHandle > 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

Detailed Description

Definition at line 49 of file LBFluid.hpp.

Member Typedef Documentation

◆ Base

using ScriptInterface::walberla::LBFluid::Base = LatticeModel<::LBWalberlaBase, LBVTKHandle>

protected

Definition at line 51 of file LBFluid.hpp.

Constructor & Destructor Documentation

◆ LBFluid()

ScriptInterface::walberla::LBFluid::LBFluid ( )

inline

Definition at line 64 of file LBFluid.hpp.

References ScriptInterface::AutoParameters< Derived, Base >::add_parameters(), ScriptInterface::ObjectHandle::context(), ScriptInterface::get_value(), m_conv_dens, m_conv_energy, m_conv_force_dens, m_conv_visc, ScriptInterface::walberla::LatticeModel<::LBWalberlaBase, LBVTKHandle >::m_instance, m_is_active, ScriptInterface::walberla::LatticeModel<::LBWalberlaBase, LBVTKHandle >::m_lattice, m_lb_params, ScriptInterface::Context::parallel_try_catch(), ScriptInterface::AutoParameter::read_only, and ScriptInterface::walberla::LatticeModel<::LBWalberlaBase, LBVTKHandle >::serialize_vtk_writers().

Member Function Documentation

◆ do_call_method()

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

overridevirtual

◆ do_construct()

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

overridevirtual

◆ get_latice_to_md_units_conversion()

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

inlineoverridevirtual

Implements ScriptInterface::walberla::LatticeModel<::LBWalberlaBase, LBVTKHandle >.

Definition at line 124 of file LBFluid.hpp.

References m_conv_dens, m_conv_press, and m_conv_speed.

Referenced by do_construct().

◆ get_lb_fluid()

auto ScriptInterface::walberla::LBFluid::get_lb_fluid ( ) const

inline

Definition at line 121 of file LBFluid.hpp.

References ScriptInterface::walberla::LatticeModel<::LBWalberlaBase, LBVTKHandle >::m_instance.

◆ get_lb_params()

auto ScriptInterface::walberla::LBFluid::get_lb_params ( ) const

inline

Definition at line 122 of file LBFluid.hpp.

References m_lb_params.

Member Data Documentation

◆ m_conv_dens

double ScriptInterface::walberla::LBFluid::m_conv_dens

protected

Definition at line 56 of file LBFluid.hpp.

Referenced by do_construct(), get_latice_to_md_units_conversion(), LBFluid(), ScriptInterface::walberla::LBFluidCPU::make_instance(), and ScriptInterface::walberla::LBFluidGPU::make_instance().

◆ m_conv_dist

double ScriptInterface::walberla::LBFluid::m_conv_dist

protected

Definition at line 54 of file LBFluid.hpp.

Referenced by do_call_method(), and do_construct().

◆ m_conv_energy

double ScriptInterface::walberla::LBFluid::m_conv_energy

protected

Definition at line 61 of file LBFluid.hpp.

Referenced by do_construct(), and LBFluid().

◆ m_conv_force

double ScriptInterface::walberla::LBFluid::m_conv_force

protected

Definition at line 59 of file LBFluid.hpp.

Referenced by do_call_method(), and do_construct().

◆ m_conv_force_dens

double ScriptInterface::walberla::LBFluid::m_conv_force_dens

protected

Definition at line 60 of file LBFluid.hpp.

Referenced by do_construct(), and LBFluid().

◆ m_conv_press

double ScriptInterface::walberla::LBFluid::m_conv_press

protected

Definition at line 58 of file LBFluid.hpp.

Referenced by do_construct(), and get_latice_to_md_units_conversion().

◆ m_conv_speed

double ScriptInterface::walberla::LBFluid::m_conv_speed

protected

Definition at line 57 of file LBFluid.hpp.

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

◆ m_conv_visc

double ScriptInterface::walberla::LBFluid::m_conv_visc

protected

Definition at line 55 of file LBFluid.hpp.

Referenced by do_construct(), LBFluid(), ScriptInterface::walberla::LBFluidCPU::make_instance(), and ScriptInterface::walberla::LBFluidGPU::make_instance().

◆ m_is_active

bool ScriptInterface::walberla::LBFluid::m_is_active

protected

Definition at line 53 of file LBFluid.hpp.

Referenced by do_call_method(), do_construct(), and LBFluid().

◆ m_lb_params

std::shared_ptr<::LB::LBWalberlaParams> ScriptInterface::walberla::LBFluid::m_lb_params

protected

Definition at line 52 of file LBFluid.hpp.

Referenced by do_call_method(), do_construct(), get_lb_params(), and LBFluid().

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

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ LBFluid()

Member Function Documentation

◆ do_call_method()

◆ do_construct()

◆ get_latice_to_md_units_conversion()

◆ get_lb_fluid()

◆ get_lb_params()

Member Data Documentation

◆ m_conv_dens

◆ m_conv_dist

◆ m_conv_energy

◆ m_conv_force

◆ m_conv_force_dens

◆ m_conv_press

◆ m_conv_speed

◆ m_conv_visc

◆ m_is_active

◆ m_lb_params