pyrokinetics.normalisation.Convention

class pyrokinetics.normalisation.Convention(name, tref_species='electron', nref_species='electron', mref_species='deuterium', vref=<Unit('vref_nrl')>, rhoref=<Unit('rhoref_pyro')>, lref=<Unit('lref_minor_radius')>, bref=<Unit('bref_B0')>, betaref=None)

Bases: object

A description of a normalisation convention, including what species reference values use, whether the velocity includes a sqrt(2) factor, what length scales are normalised to, and so on.

TODO: Do we need to specifiy “kind” of deuterium mass? Actual mass vs 2*m_p?

Parameters:

• name (str)

• tref_species (str)

• nref_species (str)

• mref_species (str)

• vref (Unit)

• rhoref (Unit)

• lref (Unit)

• bref (Unit)

• betaref (Unit)

tref_species

The species to normalise temperatures to

nref_species

The species to normalise densities to

mref_species

The species to normalise masses to

vref_multiplier

Velocity multiplier

rhoref_multiplier

gyroradius multiplier

lref_type

What to normalise length scales to

bref_type

Magnetic field normalisation. Must be either B0 or Bunit

__init__(name, tref_species='electron', nref_species='electron', mref_species='deuterium', vref=<Unit('vref_nrl')>, rhoref=<Unit('rhoref_pyro')>, lref=<Unit('lref_minor_radius')>, bref=<Unit('bref_B0')>, betaref=None)

Parameters:

• name (str)

• tref_species (str)

• nref_species (str)

• mref_species (str)

• vref (Unit)

• rhoref (Unit)

• lref (Unit)

• bref (Unit)

• betaref (Unit | None)

Methods

__init__(name[, tref_species, nref_species, ...])