pyrokinetics.gk_code.gk_output.Fluxes

pyrokinetics.gk_code.gk_output.Fluxes#

class pyrokinetics.gk_code.gk_output.Fluxes(particle=None, heat=None, momentum=None, dims=('field', 'species', 'kx', 'ky', 't'))[source]#

Bases: GKOutputArgs

Utility dataclass type used to pass fluxes to GKOutput.

__init__(particle=None, heat=None, momentum=None, dims=('field', 'species', 'kx', 'ky', 't'))#

Methods

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

items()

Dict-like items iteration

units(name, c)

Return units associated with each flux 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 fluxes.

heat

Units of [nref * vref * tref * (rhoref / lref)**2].

momentum

units of [nref * lref * tref * (rhoref / lref)**2].

names

Names of all quantities held by this dataclass

particle

Units of [nref * vref * (rhoref / lref)**2].

shape

Shape of quantities.
dims: dataclasses.InitVar[Tuple[str, ...]] = ('field', 'species', 'kx', 'ky', 't')#

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

heat: Optional[ArrayLike] = None#

Units of [nref * vref * tref * (rhoref / lref)**2].

momentum: Optional[ArrayLike] = None#

units of [nref * lref * tref * (rhoref / lref)**2].

particle: Optional[ArrayLike] = None#

Units of [nref * vref * (rhoref / lref)**2].

units(name, c)[source]#

Return units associated with each flux for a given convention

Return type:

Unit

Parameters:
Contents