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

#include <EKinWalberlaImpl.hpp>

Inheritance diagram for walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >:

Collaboration diagram for walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >:

Classes
class	DensityVTKWriter

struct	FieldTrait

class	FluxVTKWriter

struct	GhostComm

class	VTKWriter

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

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

using	FluxField = typename FieldTrait< FloatType, Architecture >::FluxField

using	DensityField = typename FieldTrait< FloatType, Architecture >::DensityField

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)

std::size_t	stencil_size () const noexcept override

bool	is_double_precision () const noexcept override

	EKinWalberlaImpl (std::shared_ptr< LatticeWalberla > lattice, double diffusion, double kT, double valency, Utils::Vector3d const &ext_efield, double density, bool advection, bool friction_coupling, bool thermalized, unsigned int seed)

double	get_diffusion () const noexcept override

double	get_kT () const noexcept override

double	get_valency () const noexcept override

bool	get_advection () const noexcept override

bool	get_friction_coupling () const noexcept override

Utils::Vector3d	get_ext_efield () const noexcept override

bool	is_thermalized () const noexcept override

unsigned int	get_seed () const noexcept override

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

void	set_diffusion (double diffusion) override

void	set_kT (double kT) override

void	set_valency (double valency) override

void	set_advection (bool advection) override

void	set_friction_coupling (bool friction_coupling) override

void	set_rng_state (uint64_t counter) override

void	set_ext_efield (Utils::Vector3d const &field) override

void	ghost_communication () override

void	ghost_communication_boundary ()

void	integrate (std::size_t potential_id, std::size_t velocity_id, std::size_t force_id, double lb_density) override

std::size_t	get_density_id () const noexcept override

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

std::optional< double >	get_node_density (Utils::Vector3i const &node, bool consider_ghosts=false) const 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< Utils::Vector3d >	get_node_flux_vector (Utils::Vector3i const &node, bool consider_ghosts=false) const override

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

void	clear_flux_boundaries () override

void	clear_density_boundaries () override

bool	set_node_flux_boundary (Utils::Vector3i const &node, Utils::Vector3d const &flux) override

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

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

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

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

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

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

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

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

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

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

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

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

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

void	update_flux_boundary_from_shape (const std::vector< int > &raster_flat, const std::vector< double > &data_flat) override

void	update_density_boundary_from_shape (const std::vector< int > &raster_flat, const std::vector< double > &data_flat) override

void	reallocate_flux_boundary_field ()

void	reallocate_density_boundary_field ()

LatticeWalberla const &	get_lattice () const noexcept override

bool	is_gpu () const noexcept override

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

	~EKinWalberlaImpl () override=default

Public Member Functions inherited from EKinWalberlaBase
	~EKinWalberlaBase () 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	FlagField = walberla::FlagField< walberla::uint8_t >

using	_FluxField = typename FieldTrait< FloatType >::FluxField

using	_DensityField = typename FieldTrait< FloatType >::DensityField

using	FullCommunicator = typename FieldTrait< FloatType, Architecture >::template RegularCommScheme< typename stencil::D3Q27 >

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

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

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

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

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

void	integrate_vtk_writers () override

Protected Attributes
BlockDataID	m_density_field_id

BlockDataID	m_flux_field_id

BlockDataID	m_flag_field_density_id

BlockDataID	m_flag_field_flux_id

FlagUID const	Domain_flag {"domain"}
	Flag for domain cells, i.e.

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

std::shared_ptr< LatticeWalberla >	m_lattice
	Block forest.

std::unique_ptr< BoundaryModelDensity >	m_boundary_density

std::shared_ptr< BoundaryModelFlux >	m_boundary_flux

std::unique_ptr< DiffusiveFluxKernel >	m_diffusive_flux

std::unique_ptr< DiffusiveFluxKernelElectrostatic >	m_diffusive_flux_electrostatic

std::unique_ptr< ContinuityKernel >	m_continuity

std::shared_ptr< FullCommunicator >	m_full_communication

std::shared_ptr< BoundaryFullCommunicator >	m_boundary_communicator

std::bitset< GhostComm::SIZE >	m_pending_ghost_comm

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<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>
class walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >

Class that runs and controls the EK on waLBerla.

Definition at line 69 of file EKinWalberlaImpl.hpp.

Member Typedef Documentation

◆ _DensityField

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::_DensityField = typename FieldTrait<FloatType>::DensityField

protected

Definition at line 167 of file EKinWalberlaImpl.hpp.

◆ _FluxField

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::_FluxField = typename FieldTrait<FloatType>::FluxField

protected

Definition at line 166 of file EKinWalberlaImpl.hpp.

◆ BlockStorage

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

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

Lattice model (e.g.

blockforest).

Definition at line 110 of file EKinWalberlaImpl.hpp.

◆ BoundaryFullCommunicator

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::BoundaryFullCommunicator = typename FieldTrait<FloatType, Architecture>::template BoundaryCommScheme< typename stencil::D3Q27>

protected

Definition at line 297 of file EKinWalberlaImpl.hpp.

◆ DensityField

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::DensityField = typename FieldTrait<FloatType, Architecture>::DensityField

Definition at line 171 of file EKinWalberlaImpl.hpp.

◆ FlagField

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::FlagField = walberla::FlagField<walberla::uint8_t>

protected

Definition at line 126 of file EKinWalberlaImpl.hpp.

◆ FluxField

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::FluxField = typename FieldTrait<FloatType, Architecture>::FluxField

Definition at line 170 of file EKinWalberlaImpl.hpp.

◆ FullCommunicator

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::FullCommunicator = typename FieldTrait<FloatType, Architecture>::template RegularCommScheme< typename stencil::D3Q27>

protected

Definition at line 294 of file EKinWalberlaImpl.hpp.

◆ PackInfo

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

template<class Field >

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::PackInfo = typename FieldTrait<FloatType, Architecture>::template PackInfo<Field>

protected

Definition at line 304 of file EKinWalberlaImpl.hpp.

◆ Stencil

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

using walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::Stencil = stencil::D3Q27

Stencil for collision and streaming operations.

Definition at line 108 of file EKinWalberlaImpl.hpp.

Constructor & Destructor Documentation

◆ EKinWalberlaImpl()

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::EKinWalberlaImpl	(	std::shared_ptr< LatticeWalberla >	lattice,
		double	diffusion,
		double	kT,
		double	valency,
		Utils::Vector3d const &	ext_efield,
		double	density,
		bool	advection,
		bool	friction_coupling,
		bool	thermalized,
		unsigned int	seed
	)

inline

Definition at line 308 of file EKinWalberlaImpl.hpp.

◆ ~EKinWalberlaImpl()

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::~EKinWalberlaImpl ( )

overridedefault

Member Function Documentation

◆ add_to_storage()

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

template<typename Field >

auto walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::add_to_storage	(	std::string const	tag,
		FloatType	value
	)

inlineprotected

Convenience function to add a field with a custom allocator.

When vectorization is off, let waLBerla decide which memory allocator to use. When vectorization is on, the aligned memory allocator is required, otherwise cpu_vectorize_info["assume_aligned"] will trigger assertions. That is because for single-precision kernels the waLBerla heuristic in src/field/allocation/FieldAllocator.h will fall back to StdFieldAlloc, yet AllocateAligned is needed for intrinsics to work.

Definition at line 250 of file EKinWalberlaImpl.hpp.

References block(), lbmpy::CPU, walberla::ek::accessor::Scalar::initialize(), walberla::ek::accessor::Flux::initialize(), and walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::m_lattice.

◆ clear_density_boundaries()

template<std::size_t FluxCount = 13, typename FloatType = double, lbmpy::Arch Architecture = lbmpy::Arch::CPU>

void walberla::EKinWalberlaImpl< FluxCount, FloatType, Architecture >::clear_density_boundaries ( )

inlineoverridevirtual

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ _DensityField

◆ _FluxField

◆ BlockStorage

◆ BoundaryFullCommunicator

◆ DensityField

◆ FlagField

◆ FluxField

◆ FullCommunicator

◆ PackInfo

◆ Stencil

Constructor & Destructor Documentation

◆ EKinWalberlaImpl()

◆ ~EKinWalberlaImpl()

Member Function Documentation

◆ add_to_storage()

◆ clear_density_boundaries()

◆ clear_flux_boundaries()

◆ FloatType_c()

◆ get_advection()

◆ get_density_id()

◆ get_diffusion()

◆ get_ext_efield()

◆ get_friction_coupling()

◆ get_kT()

◆ get_lattice()

◆ get_node_density()

◆ get_node_density_at_boundary()

◆ get_node_flux_at_boundary()

◆ get_node_flux_vector()

◆ get_node_is_boundary()

◆ get_node_is_density_boundary()

◆ get_node_is_flux_boundary()

◆ get_rng_state()

◆ get_seed()

◆ get_slice_density()

◆ get_slice_density_at_boundary()

◆ get_slice_flux_at_boundary()

◆ get_slice_flux_vector()

◆ get_slice_is_boundary()

◆ get_valency()

◆ ghost_communication()

◆ ghost_communication_boundary()

◆ integrate()

◆ integrate_vtk_writers()

◆ is_double_precision()

◆ is_gpu()

◆ is_thermalized()

◆ reallocate_density_boundary_field()

◆ reallocate_flux_boundary_field()

◆ register_vtk_field_filters()

◆ register_vtk_field_writers()

◆ remove_node_from_density_boundary()

◆ remove_node_from_flux_boundary()

◆ reset_density_boundary_handling()

◆ reset_flux_boundary_handling()

◆ set_advection()

◆ set_diffusion()

◆ set_ext_efield()

◆ set_friction_coupling()

◆ set_kT()

◆ set_node_density()

◆ set_node_density_boundary()

◆ set_node_flux_boundary()

◆ set_rng_state()

◆ set_slice_density()

◆ set_slice_density_boundary()

◆ set_slice_flux_boundary()

◆ set_valency()

◆ stencil_size()

◆ update_density_boundary_from_shape()

◆ update_flux_boundary_from_shape()

Member Data Documentation