pyrokinetics.gk_code.gk_output.Eigenfunctions#

class pyrokinetics.gk_code.gk_output.Eigenfunctions(eigenfunctions, dims=('field', 'theta', 'kx', 'ky', 'time'))[source]#

Utility dataclass type used to pass eigenfunctions to GKOutput.

Methods

`__init__`(eigenfunctions[, 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 eigenfunctions.
`names`	Names of all quantities held by this dataclass
`shape`	Shape of quantities.
`eigenfunctions`	Eigenfunction data to pass to `GKOutput`

dims: dataclasses.InitVar[Tuple[str, ...]] = ('field', 'theta', 'kx', 'ky', 'time')#: The dimensionality of the eigenfunctions. Should match data.

units(name, c)[source]#

Return units for a given convention

Return type:

Unit

Parameters:

pyrokinetics.gk_code.gk_output.Eigenfunctions