stencil::cpu::StencilUpdate< F >::Params Struct Reference

Parameters for the stencil updater. More...

#include <StencilUpdate.hpp>

Public Attributes
F	transition_function
	An instance of the transition function type.
Cell	halo_value = Cell()
	The cell value to present for cells outside of the grid.
uindex_t	iteration_offset = 0
	The iteration index offset.
uindex_t	n_iterations = 1
	The number of iterations to compute.
sycl::device	device = sycl::device()
	The device to use for computations.
bool	blocking = false
	Should the stencil updater block until completion, or return immediately after all kernels have been submitted.

Detailed Description

template<concepts::TransitionFunction F>
struct stencil::cpu::StencilUpdate< F >::Params

Parameters for the stencil updater.

Member Data Documentation

blocking

template<concepts::TransitionFunction F>

bool stencil::cpu::StencilUpdate< F >::Params::blocking = false

Should the stencil updater block until completion, or return immediately after all kernels have been submitted.

Choosing one option or the other won't effect the correctness: For example, if you choose a non-blocking stencil updater and immediately try to access the grid after the updater has returned, SYCL/OneAPI will block your thread until the computations are complete and it can actually provide you access to the data.

device

template<concepts::TransitionFunction F>

sycl::device stencil::cpu::StencilUpdate< F >::Params::device = sycl::device()

The device to use for computations.

halo_value

template<concepts::TransitionFunction F>

Cell stencil::cpu::StencilUpdate< F >::Params::halo_value = Cell()

The cell value to present for cells outside of the grid.

iteration_offset

template<concepts::TransitionFunction F>

uindex_t stencil::cpu::StencilUpdate< F >::Params::iteration_offset = 0

The iteration index offset.

This offset will be added to the "actual" iteration index. This way, simulations can "resume" with the next timestep if the intermediate grid has been evaluated by the host.

n_iterations

template<concepts::TransitionFunction F>

uindex_t stencil::cpu::StencilUpdate< F >::Params::n_iterations = 1

The number of iterations to compute.

transition_function

template<concepts::TransitionFunction F>

F stencil::cpu::StencilUpdate< F >::Params::transition_function

An instance of the transition function type.

User applications may store runtime parameters here.

---

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

• StencilStream/cpu/StencilUpdate.hpp