pyrokinetics.gk_code.gk_output

pyrokinetics.gk_code.gk_output#

Functions

read_gk_output(path, norm[, ...])

Read gyrokinetics output file(s) from disk, returning an GKOutput instance.

supported_gk_output_types()

Returns a list of all registered GKOutput file types.

Classes

Coords(kx, ky, time, species[, theta, mode, ...])

Utility dataclass type used to pass coordinates to GKOutput

Eigenfunctions(eigenfunctions[, dims])

Utility dataclass type used to pass eigenfunctions to GKOutput.

Eigenvalues(growth_rate, mode_frequency[, dims])

Utility dataclass type used to pass eigenvalues to GKOutput.

Fields([phi, apar, bpar, dims])

Utility dataclass type used to pass field data to GKOutput.

Fluxes([particle, heat, momentum, dims])

Utility dataclass type used to pass fluxes to GKOutput.

GKOutput(*, coords, norm[, ...])

Contains the output data from gyrokinetics codes.

GKOutputArgs()

Utility base dataclass used to pass quantities to GKOutput.

Moments([density, temperature, velocity, dims])

Utility dataclass type used to pass moments to GKOutput.