Enum ParticleStatus

Enum Documentation

enum class lili::particle::ParticleStatus

Enumeration class for the particle status.

This enumeration class is useful to flag the particle and can be extended further. Currently it tracks whether the particle is tracked or not and whether it has crossed the boundary or not.

Values:

enumerator Out

Out of domain, to be removed.

enumerator In

Inside the domain.

enumerator Tracked

Tracked, inside the domain.

enumerator X0

Crossed the -X boundary.

enumerator X1

Crossed the +X boundary.

enumerator Y0

Crossed the -Y boundary.

enumerator Y1

Crossed the +Y boundary.

enumerator Z0

Crossed the -Z boundary.

enumerator Z1

Crossed the +Z boundary.

enumerator X0Y0

Crossed the -X and -Y boundary.

enumerator X0Y1

Crossed the -X and +Y boundary.

enumerator X1Y0

Crossed the +X and -Y boundary.

enumerator X1Y1

Crossed the +X and +Y boundary.

enumerator X0Z0

Crossed the -X and -Z boundary.

enumerator X0Z1

Crossed the -X and +Z boundary.

enumerator X1Z0

Crossed the +X and -Z boundary.

enumerator X1Z1

Crossed the +X and +Z boundary.

enumerator Y0Z0

Crossed the -Y and -Z boundary.

enumerator Y0Z1

Crossed the -Y and +Z boundary.

enumerator Y1Z0

Crossed the +Y and -Z boundary.

enumerator Y1Z1

Crossed the +Y and +Z boundary.

enumerator X0Y0Z0

Crossed the -X, -Y, and -Z boundary.

enumerator X0Y0Z1

Crossed the -X, -Y, and +Z boundary.

enumerator X0Y1Z0

Crossed the -X, +Y, and -Z boundary.

enumerator X0Y1Z1

Crossed the -X, +Y, and +Z boundary.

enumerator X1Y0Z0

Crossed the +X, -Y, and -Z boundary.

enumerator X1Y0Z1

Crossed the +X, -Y, and +Z boundary.

enumerator X1Y1Z0

Crossed the +X, +Y, and -Z boundary.

enumerator X1Y1Z1

Crossed the +X, +Y, and +Z boundary.

enumerator TX0

Tracked, crossed the -X boundary.

enumerator TX1

Tracked, crossed the +X boundary.

enumerator TY0

Tracked, crossed the -Y boundary.

enumerator TY1

Tracked, crossed the +Y boundary.

enumerator TZ0

Tracked, crossed the -Z boundary.

enumerator TZ1

Tracked, crossed the +Z boundary.

enumerator TX0Y0

Tracked, crossed the -X and -Y boundary.

enumerator TX0Y1

Tracked, crossed the -X and +Y boundary.

enumerator TX1Y0

Tracked, crossed the +X and -Y boundary.

enumerator TX1Y1

Tracked, crossed the +X and +Y boundary.

enumerator TX0Z0

Tracked, crossed the -X and -Z boundary.

enumerator TX0Z1

Tracked, crossed the -X and +Z boundary.

enumerator TX1Z0

Tracked, crossed the +X and -Z boundary.

enumerator TX1Z1

Tracked, crossed the +X and +Z boundary.

enumerator TY0Z0

Tracked, crossed the -Y and -Z boundary.

enumerator TY0Z1

Tracked, crossed the -Y and +Z boundary.

enumerator TY1Z0

Tracked, crossed the +Y and -Z boundary.

enumerator TY1Z1

Tracked, crossed the +Y and +Z boundary.

enumerator TX0Y0Z0

Tracked, crossed the -X, -Y, and -Z boundary.

enumerator TX0Y0Z1

Tracked, crossed the -X, -Y, and +Z boundary.

enumerator TX0Y1Z0

Tracked, crossed the -X, +Y, and -Z boundary.

enumerator TX0Y1Z1

Tracked, crossed the -X, +Y, and +Z boundary.

enumerator TX1Y0Z0

Tracked, crossed the +X, -Y, and -Z boundary.

enumerator TX1Y0Z1

Tracked, crossed the +X, -Y, and +Z boundary.

enumerator TX1Y1Z0

Tracked, crossed the +X, +Y, and -Z boundary.

enumerator TX1Y1Z1

Tracked, crossed the +X, +Y, and +Z boundary.