pyrokinetics.gk_code.gk_output.Eigenvalues

class pyrokinetics.gk_code.gk_output.Eigenvalues(growth_rate, mode_frequency, dims=('kx', 'ky', 'time'))

Bases: GKOutputArgs

Utility dataclass type used to pass eigenvalues to GKOutput. Unlike the classes Fields, Fluxes, and Moments, all entries to Eigenvalues are non-optional.

__init__(growth_rate, mode_frequency, dims=('kx', 'ky', 'time'))

Methods

__init__(growth_rate, mode_frequency[, dims])
items()	Dict-like items iteration
units(name, c)	Return units for a given convention
values()	Dict-like values iteration
with_units(c)	Apply units to each quantity in turn and return a new Coords.

Attributes

coords	Tuple containing the names of each supplied field (those that aren't None).
dims	The dimensionality of the eigenvalues Each array should have the same dimensionality.
names	Names of all quantities held by this dataclass
shape	Shape of quantities.
growth_rate	Units of [vref / lref].
mode_frequency	Units of [vref / lref].

dims: dataclasses.InitVar[Tuple[str, ...]] = ('kx', 'ky', 'time')

The dimensionality of the eigenvalues Each array should have the same dimensionality.

growth_rate: ArrayLike

Units of [vref / lref].

mode_frequency: ArrayLike

Units of [vref / lref].

units(name, c)

Return units for a given convention

Return type:

Unit

Parameters:

• name (str)

• c (ConventionNormalisation)