ArrayOrdering

Contents

ArrayOrdering#

ArrayOrdering#

Type alias for the memory-order convention accepted by remesh_array().

Controls how the bits of a MeshCodeType integer map to numpy array axes.

'F'

Fortran (column-major) order — the default for PSI data. Because PSI HDF files are written by Fortran code, the physical (r, θ, φ) axis ordering is reversed in numpy storage: the last numpy axis corresponds to \(r\), the middle to \(\theta\), and the first to \(\varphi\). The most-significant bit of the mesh code therefore maps to the last numpy axis. Use this setting whenever the array was loaded directly from a PSI HDF file.

'C'

C (row-major) order. Use when the array has been transposed to numpy-native axis order (first axis = first physical coordinate, e.g. shape (Nr, Nθ, Nφ)), so that the most-significant bit maps to the first numpy axis.

alias of Literal[‘F’, ‘C’]