This type is part of the index definition, and defines the coloring of an individal axis. More...

Public Attributes
bool	auxiliary = false
	Whether the entity is a delimiter in this axis.

util::id	bdepth = 0
	Number of boundary padding layers to be added at each end of the axis.

util::offsets	colormap
	Encodes the number of colors into which axis will be divided, and the extents to be partitioned.

util::id	hdepth = 0
	halo depth (or number of ghost layers) of axis

bool	periodic = false
	Whether the axis is periodic.

Detailed Description

This type is part of the index definition, and defines the coloring of an individal axis.

Member Data Documentation

◆ colormap

util::offsets colormap

Encodes the number of colors into which axis will be divided, and the extents to be partitioned.

◆ hdepth

util::id hdepth = 0

halo depth (or number of ghost layers) of axis

◆ bdepth

util::id bdepth = 0

Number of boundary padding layers to be added at each end of the axis.

◆ periodic

bool periodic = false

Whether the axis is periodic.

Ghosts are added at each end of a periodic axis; for backward compatibility, bdepth must equal hdepth.

◆ auxiliary

bool auxiliary = false

Whether the entity is a delimiter in this axis.

In a structured mesh, a face is a delimiter in the one axis perpendicular to it; a vertex is a delimiter in all axes.

Without considering auxiliary, the axis_definition objects for an index space describe a set of primary entities ("cells"). Each non-periodic, auxiliary axis is augmented with an additional index point at the high end, such that every primary has an auxiliary on each side. Each color owns the auxiliaries just before its first primaries. Ghost copies are performed for auxiliary entities associated with ghost layers of primaries in accordance with index_definition::full_ghosts.

Note: The primaries in terms of which auxiliaries are defined need not exist as their own index space.