pyrokinetics.gk_code.gk_output.Fields

pyrokinetics.gk_code.gk_output.Fields#

class pyrokinetics.gk_code.gk_output.Fields(phi=None, apar=None, bpar=None, dims=('theta', 'kx', 'ky', 't'))[source]#

Bases: GKOutputArgs

Utility dataclass type used to pass field data to GKOutput.

__init__(phi=None, apar=None, bpar=None, dims=('theta', 'kx', 'ky', 't'))#

Methods

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

items()

Dict-like items iteration

units(name, c)

Return units associated with each field 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

apar

Parallel component of the magnetic vector potential.

bpar

Parallel component of the magnetic flux density.

coords

Tuple containing the names of each supplied field (those that aren't None).

dims

The dimensionality of the fields.

names

Names of all quantities held by this dataclass

phi

the electrostatic potential.

shape

Shape of quantities.
apar: Optional[ArrayLike] = None#

Parallel component of the magnetic vector potential. Units of [bref * rhoref**2 / lref].

Type:

\(A_\parallel\)

bpar: Optional[ArrayLike] = None#

Parallel component of the magnetic flux density. Units of [bref * rhoref / lref].

Type:

\(B_\parallel\)

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

The dimensionality of the fields. Each field should have the same number of dimensions.

phi: Optional[ArrayLike] = None#

the electrostatic potential. Units of [tref * rhoref / (qref * lref)]

Type:

\(\phi\)

units(name, c)[source]#

Return units associated with each field for a given convention

Return type:

Unit

Parameters:
Contents