Constant value¶

This page provides a list of constant values that are primarily used as arguments in other APIs.

`sdecomp_dir_t`¶

Constant values to represent the spatial directions, \(x\), \(y\), \(z\).
include/sdecomp.h¶
typedef uint_fast8_t sdecomp_dir_t;
extern const sdecomp_dir_t SDECOMP_XDIR; // 0
extern const sdecomp_dir_t SDECOMP_YDIR; // 1
extern const sdecomp_dir_t SDECOMP_ZDIR; // 2
Note

For two-dimensional domains, SDECOMP_ZDIR is not applicable.

`sdecomp_pencil_t`¶

Constant values to represent the pencil types.

include/sdecomp.h¶

typedef uint_fast8_t sdecomp_pencil_t;
extern const sdecomp_pencil_t SDECOMP_X1PENCIL; // 0
extern const sdecomp_pencil_t SDECOMP_Y1PENCIL; // 1
extern const sdecomp_pencil_t SDECOMP_Z1PENCIL; // 2
extern const sdecomp_pencil_t SDECOMP_X2PENCIL; // 3
extern const sdecomp_pencil_t SDECOMP_Y2PENCIL; // 4
extern const sdecomp_pencil_t SDECOMP_Z2PENCIL; // 5

Note

For two-dimensional domains, the last four values are not applicable.