walberla::v8::memory::FieldSlices Class Reference

Detailed Description

Iteration slices and cell intervals over a field.

#include <Field.hpp>

Public Member Functions
	FieldSlices (std::array< size_t, 3 > fieldShape, size_t numGhostLayers)
CellInterval	interior () const
	Get the interior cell interval for each of a fields' per-block views.
CellInterval	withGhostLayers () const
	Get the full cell interval for each of a fields' per-block views, including the interior and all ghost layers.
CellInterval	withGhostLayers (size_t gls) const
	Get an expanded cell interval for each of a fields' per-block views, including the interior and the given number of ghost layers.
CellInterval	ghostSlice (stencil::Direction dir, size_t thickness=1, bool fullSlice=false) const
	Get a cell interval for a ghost layer slice in a certain direction.
CellInterval	borderSlice (stencil::Direction dir, size_t thickness=1, bool fullSlice=false) const
	Get a cell interval for a border slice in a certain direction.

Private Attributes
std::array< size_t, 3 >	shape_
size_t	numGhostLayers_

Constructor & Destructor Documentation

FieldSlices()

walberla::v8::memory::FieldSlices::FieldSlices ( std::array< size_t, 3 > fieldShape, size_t numGhostLayers )

inline

Member Function Documentation

borderSlice()

CellInterval walberla::v8::memory::FieldSlices::borderSlice ( stencil::Direction dir, size_t thickness = 1, bool fullSlice = false ) const

inline

Get a cell interval for a border slice in a certain direction.

Parameters

dir	The direction in which the border slice should be taken
thickness	The number of cell layers to include
fullSlice	If true, fully expand the slice in normal directions to include all ghost layers

ghostSlice()

CellInterval walberla::v8::memory::FieldSlices::ghostSlice ( stencil::Direction dir, size_t thickness = 1, bool fullSlice = false ) const

inline

Get a cell interval for a ghost layer slice in a certain direction.

Parameters

dir	The direction in which the ghost-layer slice should be taken
thickness	The number of ghost layers to include
fullSlice	If true, fully expand the slice in normal directions to include all ghost layers

interior()

CellInterval walberla::v8::memory::FieldSlices::interior ( ) const

inline

Get the interior cell interval for each of a fields' per-block views.

withGhostLayers() [1/2]

CellInterval walberla::v8::memory::FieldSlices::withGhostLayers ( ) const

inline

Get the full cell interval for each of a fields' per-block views, including the interior and all ghost layers.

withGhostLayers() [2/2]

CellInterval walberla::v8::memory::FieldSlices::withGhostLayers ( size_t gls ) const

inline

Get an expanded cell interval for each of a fields' per-block views, including the interior and the given number of ghost layers.

Member Data Documentation

numGhostLayers_

size_t walberla::v8::memory::FieldSlices::numGhostLayers_

private

shape_

std::array< size_t, 3 > walberla::v8::memory::FieldSlices::shape_

private

---

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

• /builds/administration/walberla-website/walberla/include/walberla/v8/memory/Field.hpp