Class that runs and controls the LB on waLBerla. More...

#include <LBWalberlaImpl.hpp>

Inheritance diagram for walberla::LBWalberlaImpl< FloatType, Architecture >:

Collaboration diagram for walberla::LBWalberlaImpl< FloatType, Architecture >:

Classes
struct	GhostComm

Public Types
using	Stencil = stencil::D3Q19
	Stencil for collision and streaming operations.

using	StencilFull = stencil::D3Q27
	Stencil for ghost communication (includes domain corners).

using	BlockStorage = LatticeWalberla::Lattice_T
	Lattice model (e.g.

using	PdfField = FieldTrait< FloatType, Stencil, Architecture >::PdfField

using	VectorField = FieldTrait< FloatType, Stencil, Architecture >::VectorField

using	FlagField = BoundaryModel::FlagField

Public Types inherited from LatticeModel
using	units_map = std::unordered_map< std::string, double >

Public Member Functions
template<typename T >
FloatType	FloatType_c (T t) const

std::size_t	stencil_size () const noexcept override

bool	is_double_precision () const noexcept override

bool	is_gpu () const noexcept override

	LBWalberlaImpl (std::shared_ptr< LatticeWalberla > lattice, double viscosity, double density)

	~LBWalberlaImpl () override=default

void	integrate () override

void	set_collision_model (double kT, unsigned int seed) override
	Set up the thermalized collision model.

void	set_collision_model (std::unique_ptr< LeesEdwardsPack > &&lees_edwards_pack) override
	Set up the Lees-Edwards collision model.

void	check_lebc (unsigned int shear_direction, unsigned int shear_plane_normal) const override
	Verify that MD and LB Lees-Edwards parameters are consistent.

void	ghost_communication () override
	Perform all pending ghost layer updates.

void	ghost_communication_pdf () override

void	ghost_communication_vel () override

void	ghost_communication_laf () override

void	ghost_communication_boundary ()

void	ghost_communication_full ()
	Communicate all fields at once using the D3Q27 stencil.

void	apply_lees_edwards_interpolation ()

std::optional< Utils::Vector3d >	get_node_velocity (Utils::Vector3i const &node, bool consider_ghosts=false) const override

bool	set_node_velocity (Utils::Vector3i const &node, Utils::Vector3d const &v) override

std::vector< double >	get_slice_velocity (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const override

void	set_slice_velocity (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &velocity) override

std::optional< double >	get_node_density (Utils::Vector3i const &node, bool consider_ghosts=false) const override

bool	set_node_density (Utils::Vector3i const &node, double density) override

std::vector< double >	get_slice_density (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const override

void	set_slice_density (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &density) override

std::optional< std::vector< double > >	get_node_population (Utils::Vector3i const &node, bool consider_ghosts=false) const override

bool	set_node_population (Utils::Vector3i const &node, std::vector< double > const &population) override

std::vector< double >	get_slice_population (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const override

void	set_slice_population (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &population) override

std::optional< Utils::Vector3d >	get_node_force_to_be_applied (Utils::Vector3i const &node) const override

std::optional< Utils::Vector3d >	get_node_last_applied_force (Utils::Vector3i const &node, bool consider_ghosts=false) const override

bool	set_node_last_applied_force (Utils::Vector3i const &node, Utils::Vector3d const &force) override

std::vector< double >	get_slice_last_applied_force (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const override

void	set_slice_last_applied_force (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &force) override

std::optional< Utils::VectorXd< 9 > >	get_node_pressure_tensor (Utils::Vector3i const &node) const override

std::vector< double >	get_slice_pressure_tensor (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const override

std::function< bool(Utils::Vector3d const &)>	make_lattice_position_checker (bool consider_points_in_halo) const override

bool	add_force_at_pos (Utils::Vector3d const &pos, Utils::Vector3d const &force) override

void	add_forces_at_pos (std::vector< Utils::Vector3d > const &pos, std::vector< Utils::Vector3d > const &forces) override
	Distribute forces to the lattice at given positions.

std::optional< Utils::Vector3d >	get_velocity_at_pos (Utils::Vector3d const &pos, bool consider_points_in_halo=false) const override

std::vector< Utils::Vector3d >	get_velocities_at_pos (std::vector< Utils::Vector3d > const &pos) override
	Interpolate velocities at given positions (batch version).

std::optional< double >	get_density_at_pos (Utils::Vector3d const &pos, bool consider_points_in_halo=false) const override

std::vector< double >	get_densities_at_pos (std::vector< Utils::Vector3d > const &pos) override

void	reset_boundary_handling (std::shared_ptr< BlockStorage > const &blocks)

void	on_boundary_add ()
	Lazily enable boundary mode on first boundary addition.

void	clear_boundaries () override

void	reallocate_ubb_field () override

void	update_boundary_from_shape (std::vector< int > const &raster_flat, std::vector< double > const &data_flat) override
	Set boundary conditions from a rasterized shape.

std::optional< Utils::Vector3d >	get_node_velocity_at_boundary (Utils::Vector3i const &node, bool consider_ghosts=false) const override

bool	set_node_velocity_at_boundary (Utils::Vector3i const &node, Utils::Vector3d const &velocity) override

std::vector< std::optional< Utils::Vector3d > >	get_slice_velocity_at_boundary (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const override

void	set_slice_velocity_at_boundary (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< std::optional< Utils::Vector3d > > const &velocity) override

std::optional< Utils::Vector3d >	get_node_boundary_force (Utils::Vector3i const &node) const override

bool	remove_node_from_boundary (Utils::Vector3i const &node) override

std::optional< bool >	get_node_is_boundary (Utils::Vector3i const &node, bool consider_ghosts=false) const override

std::vector< bool >	get_slice_is_boundary (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const override

Utils::Vector3d	get_boundary_force_from_shape (std::vector< int > const &raster_flat) const override
	Total force exerted by the fluid on a subset of boundary nodes.

Utils::Vector3d	get_boundary_force () const override

Utils::VectorXd< 9 >	get_pressure_tensor () const override

Utils::Vector3d	get_momentum () const override

void	set_external_force (Utils::Vector3d const &ext_force) override

Utils::Vector3d	get_external_force () const noexcept override

void	set_viscosity (double viscosity) override

double	get_viscosity () const noexcept override

double	get_density () const noexcept override

double	get_kT () const noexcept override

unsigned int	get_seed () const noexcept override

std::optional< uint64_t >	get_rng_state () const override

void	set_rng_state (uint64_t counter) override

LatticeWalberla const &	get_lattice () const noexcept override

std::size_t	get_velocity_field_id () const noexcept override

std::size_t	get_force_field_id () const noexcept override

FloatType	pressure_tensor_correction_factor () const
	Correction factor for off-diagonal pressure tensor elements.

void	pressure_tensor_correction (Matrix3< FloatType > &tensor) const

void	pressure_tensor_correction (std::span< FloatType, 9ul > tensor) const

void	register_vtk_field_filters (walberla::vtk::VTKOutput &vtk_obj) override

void	register_vtk_field_writers (walberla::vtk::VTKOutput &vtk_obj, LatticeModel::units_map const &units, int flag_observables) override

Public Member Functions inherited from LBWalberlaBase
	~LBWalberlaBase () override=default

Public Member Functions inherited from LatticeModel
virtual	~LatticeModel ()=default

std::shared_ptr< VTKHandle >	create_vtk (int delta_N, int initial_count, int flag_observables, units_map const &units_conversion, std::string const &identifier, std::string const &base_folder, std::string const &prefix, bool force_pvtu)
	Create a VTK observable.

void	write_vtk (std::string const &vtk_uid)
	Write a VTK observable to disk.

void	switch_vtk (std::string const &vtk_uid, bool status)
	Toggle a VTK observable on/off.

Protected Types
using	Kernels = detail::KernelTrait< FloatType, Architecture >

using	BoundaryModel = BoundaryHandling< FloatType, Vector3< FloatType >, typename Kernels::DynamicUBB >

using	CollisionModel = std::variant< typename Kernels::StreamCollisionModelThermalized, typename Kernels::StreamCollisionModelLeesEdwards >

using	_PdfField = FieldTrait< FloatType, Stencil >::PdfField

using	_VectorField = FieldTrait< FloatType, Stencil >::VectorField

using	RegularFullCommunicator = FieldTrait< FloatType, Stencil, Architecture >::template RegularCommScheme< stencil::D3Q27 >
	Full communicator.

using	BoundaryFullCommunicator = FieldTrait< FloatType, Stencil, Architecture >::template BoundaryCommScheme< stencil::D3Q27 >

using	PDFStreamingCommunicator = FieldTrait< FloatType, Stencil, Architecture >::template RegularCommScheme< Stencil >
	Regular communicator.

template<class Field >
using	PackInfo = FieldTrait< FloatType, Stencil, Architecture >::template PackInfo< Field >

Protected Member Functions
void	integrate_vtk_writers () override

template<typename T >
void	zero_centered_transform_impl (T &data, auto const factor) const
	Scale data by a conversion factor (in-place).

void	zero_centered_to_lb_in_place (auto &data) const

void	zero_centered_to_md_in_place (auto &data) const

auto	zero_centered_to_lb (auto const &data) const

auto	zero_centered_to_md (auto const &data) const

template<typename Field >
auto	add_to_storage (std::string const tag)
	Convenience function to add a field with a custom allocator.

void	setup_full_communicator ()
	Set up D3Q27 communicators for full ghost layer updates.

void	setup_streaming_communicator ()
	Set up the communicator used during integration.

Protected Attributes
FloatType	m_viscosity

FloatType	m_density
	kinematic viscosity

FloatType	m_kT

unsigned int	m_seed

double	m_zc_to_md

double	m_zc_to_lb

std::shared_ptr< LatticeWalberla >	m_lattice

BlockDataID	m_pdf_field_id

BlockDataID	m_pdf_tmp_field_id

BlockDataID	m_flag_field_id

BlockDataID	m_last_applied_force_field_id

BlockDataID	m_force_to_be_applied_id

BlockDataID	m_velocity_field_id

BlockDataID	m_vel_tmp_field_id

std::optional< BlockDataID >	m_pressure_tensor_field_id

FlagUID const	Boundary_flag {"boundary"}
	Flag for boundary cells.

bool	m_has_boundaries {false}

std::shared_ptr< BoundaryModel >	m_boundary

std::shared_ptr< BoundaryFullCommunicator >	m_boundary_communicator

std::shared_ptr< RegularFullCommunicator >	m_full_communicator

std::shared_ptr< RegularFullCommunicator >	m_pdf_communicator

std::shared_ptr< RegularFullCommunicator >	m_vel_communicator

std::shared_ptr< RegularFullCommunicator >	m_laf_communicator

std::shared_ptr< PDFStreamingCommunicator >	m_pdf_streaming_communicator

std::bitset< GhostComm::SIZE >	m_pending_ghost_comm

ResourceObserver	m_mpi_cart_comm_observer

std::shared_ptr< CollisionModel >	m_collision_model

std::shared_ptr< ResetForce< PdfField, VectorField > >	m_reset_force

std::shared_ptr< typename Kernels::UpdateVelFromPDF >	m_update_velocities_from_pdf

std::shared_ptr< LeesEdwardsPack >	m_lees_edwards_callbacks

std::shared_ptr< InterpolateAndShiftAtBoundary< _PdfField, FloatType > >	m_lees_edwards_pdf_interpol_sweep

std::shared_ptr< InterpolateAndShiftAtBoundary< _VectorField, FloatType > >	m_lees_edwards_vel_interpol_sweep

std::shared_ptr< InterpolateAndShiftAtBoundary< _VectorField, FloatType > >	m_lees_edwards_last_applied_force_interpol_sweep

Protected Attributes inherited from LatticeModel
std::map< std::string, std::shared_ptr< VTKHandle > >	m_vtk_auto
	VTK writers that are executed automatically.

std::map< std::string, std::shared_ptr< VTKHandle > >	m_vtk_manual
	VTK writers that are executed manually.

Detailed Description

template<typename FloatType, lbmpy::Arch Architecture>
class walberla::LBWalberlaImpl< FloatType, Architecture >

Class that runs and controls the LB on waLBerla.

Definition at line 85 of file LBWalberlaImpl.hpp.

Member Typedef Documentation

◆ _PdfField

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::_PdfField = FieldTrait<FloatType, Stencil>::PdfField

protected

Definition at line 110 of file LBWalberlaImpl.hpp.

◆ _VectorField

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::_VectorField = FieldTrait<FloatType, Stencil>::VectorField

protected

Definition at line 111 of file LBWalberlaImpl.hpp.

◆ BlockStorage

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::BlockStorage = LatticeWalberla::Lattice_T

Lattice model (e.g.

blockforest).

Definition at line 106 of file LBWalberlaImpl.hpp.

◆ BoundaryFullCommunicator

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::BoundaryFullCommunicator = FieldTrait<FloatType, Stencil, Architecture>::template BoundaryCommScheme<stencil::D3Q27>

protected

Definition at line 142 of file LBWalberlaImpl.hpp.

◆ BoundaryModel

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::BoundaryModel = BoundaryHandling<FloatType, Vector3<FloatType>, typename Kernels::DynamicUBB>

protected

Definition at line 94 of file LBWalberlaImpl.hpp.

◆ CollisionModel

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::CollisionModel = std::variant<typename Kernels::StreamCollisionModelThermalized, typename Kernels::StreamCollisionModelLeesEdwards>

protected

Definition at line 96 of file LBWalberlaImpl.hpp.

◆ FlagField

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::FlagField = BoundaryModel::FlagField

Definition at line 116 of file LBWalberlaImpl.hpp.

◆ Kernels

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::Kernels = detail::KernelTrait<FloatType, Architecture>

protected

Definition at line 93 of file LBWalberlaImpl.hpp.

◆ PackInfo

template<typename FloatType , lbmpy::Arch Architecture>

template<class Field >

using walberla::LBWalberlaImpl< FloatType, Architecture >::PackInfo = FieldTrait<FloatType, Stencil, Architecture>::template PackInfo<Field>

protected

Definition at line 153 of file LBWalberlaImpl.hpp.

◆ PdfField

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::PdfField = FieldTrait<FloatType, Stencil, Architecture>::PdfField

Definition at line 114 of file LBWalberlaImpl.hpp.

◆ PDFStreamingCommunicator

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::PDFStreamingCommunicator = FieldTrait<FloatType, Stencil, Architecture>::template RegularCommScheme<Stencil>

protected

Regular communicator.

We use the same directions as the stencil during integration.

Definition at line 149 of file LBWalberlaImpl.hpp.

◆ RegularFullCommunicator

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::RegularFullCommunicator = FieldTrait<FloatType, Stencil, Architecture>::template RegularCommScheme<stencil::D3Q27>

protected

Full communicator.

We use the D3Q27 directions to update cells along the diagonals during a full ghost communication. This is needed to properly update the corners of the ghost layer when setting cell velocities or populations.

Definition at line 139 of file LBWalberlaImpl.hpp.

◆ Stencil

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::Stencil = stencil::D3Q19

Stencil for collision and streaming operations.

Definition at line 102 of file LBWalberlaImpl.hpp.

◆ StencilFull

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::StencilFull = stencil::D3Q27

Stencil for ghost communication (includes domain corners).

Definition at line 104 of file LBWalberlaImpl.hpp.

◆ VectorField

template<typename FloatType , lbmpy::Arch Architecture>

using walberla::LBWalberlaImpl< FloatType, Architecture >::VectorField = FieldTrait<FloatType, Stencil, Architecture>::VectorField

Definition at line 115 of file LBWalberlaImpl.hpp.

Constructor & Destructor Documentation

◆ LBWalberlaImpl()

template<typename FloatType , lbmpy::Arch Architecture>

walberla::LBWalberlaImpl< FloatType, Architecture >::LBWalberlaImpl	(	std::shared_ptr< LatticeWalberla >	lattice,
		double	viscosity,
		double	density
	)

inline

Definition at line 241 of file LBWalberlaImpl.hpp.

◆ ~LBWalberlaImpl()

template<typename FloatType , lbmpy::Arch Architecture>

walberla::LBWalberlaImpl< FloatType, Architecture >::~LBWalberlaImpl ( )

overridedefault

Member Function Documentation

◆ add_force_at_pos()

template<typename FloatType , lbmpy::Arch Architecture>

bool walberla::LBWalberlaImpl< FloatType, Architecture >::add_force_at_pos	(	Utils::Vector3d const &	pos,
		Utils::Vector3d const &	force
	)

overridevirtual

raster_flat	Flattened 3D mask (non-zero = boundary node).
data_flat	Flattened 3D array of slip velocities (3 components per node, same ordering as `raster_flat`).

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ _PdfField

◆ _VectorField

◆ BlockStorage

◆ BoundaryFullCommunicator

◆ BoundaryModel

◆ CollisionModel

◆ FlagField

◆ Kernels

◆ PackInfo

◆ PdfField

◆ PDFStreamingCommunicator

◆ RegularFullCommunicator

◆ Stencil

◆ StencilFull

◆ VectorField

Constructor & Destructor Documentation

◆ LBWalberlaImpl()

◆ ~LBWalberlaImpl()

Member Function Documentation

◆ add_force_at_pos()

◆ add_forces_at_pos()

◆ add_to_storage()

◆ apply_lees_edwards_interpolation()

◆ check_lebc()

◆ clear_boundaries()

◆ FloatType_c()

◆ get_boundary_force()

◆ get_boundary_force_from_shape()

◆ get_densities_at_pos()

◆ get_density()

◆ get_density_at_pos()

◆ get_external_force()

◆ get_force_field_id()

◆ get_kT()

◆ get_lattice()

◆ get_momentum()

◆ get_node_boundary_force()

◆ get_node_density()

◆ get_node_force_to_be_applied()

◆ get_node_is_boundary()

◆ get_node_last_applied_force()

◆ get_node_population()

◆ get_node_pressure_tensor()

◆ get_node_velocity()

◆ get_node_velocity_at_boundary()

◆ get_pressure_tensor()

◆ get_rng_state()

◆ get_seed()

◆ get_slice_density()

◆ get_slice_is_boundary()

◆ get_slice_last_applied_force()

◆ get_slice_population()

◆ get_slice_pressure_tensor()

◆ get_slice_velocity()

◆ get_slice_velocity_at_boundary()

◆ get_velocities_at_pos()

◆ get_velocity_at_pos()

◆ get_velocity_field_id()

◆ get_viscosity()

◆ ghost_communication()

◆ ghost_communication_boundary()

◆ ghost_communication_full()

◆ ghost_communication_laf()

◆ ghost_communication_pdf()

◆ ghost_communication_vel()

◆ integrate()

◆ integrate_vtk_writers()

◆ is_double_precision()

◆ is_gpu()

◆ make_lattice_position_checker()

◆ on_boundary_add()

◆ pressure_tensor_correction() [1/2]