tracmass.FluxFields#

class tracmass.FluxFields(*, dzt, zstot, uflux, vflux, wflux=None)[source]#

Bases: object

Two-slot time window of velocity flux data for the advection kernels.

Each array field has a trailing dimension of size 2, where slot 0 holds the ‘past’ time level and slot 1 holds the ‘present’ time level.

FluxFields is a JAX pytree and is passed as a dynamic argument to the compiled step functions. Obtain one from a LazyFluxFields by calling compute().

Parameters:
dzt#

Layer thickness at tracer points, shape (imt, jmt, km, 2).

Type:

jnp.ndarray

zstot#

Total sea-surface height anomaly, shape (imt, jmt, 2).

Type:

jnp.ndarray

uflux#

Zonal volume flux, shape (imt, jmt, km, 2).

Type:

jnp.ndarray

vflux#

Meridional volume flux, shape (imt, jmt+1, km, 2).

Type:

jnp.ndarray

wflux#

Vertical volume flux in the kernel convention: wflux[..., k, :] is the flux through the bottom face of level k (level 0 at the surface), positive downward. Adapters supply the model convention (top face, positive upward); see _w_to_kernel(). None disables vertical particle motion.

Type:

jnp.ndarray or None

__init__(*, dzt, zstot, uflux, vflux, wflux=None)#
Parameters:
Return type:

None

Methods

__init__(*, dzt, zstot, uflux, vflux[, wflux])

Attributes

wflux

dzt

zstot

uflux

vflux