pyrokinetics.normalisation.ConventionNormalisation

class pyrokinetics.normalisation.ConventionNormalisation(convention, parent)

Bases: Normalisation

A concrete set of reference values/normalisations.

You should call set_lref, set_bref and then set_kinetic_references (in that order) before attempting to use most of these units

Parameters:

• run_name – Name of the specific simulation run

• convention (Convention) – Object describing how particular reference values should be set

• registry – The pint registry to add these units to

• definitions – Dictionary of definitions for each reference value. If not given, the default set will be used

• parent (SimulationNormalisation)

__init__(convention, parent)

Parameters:

• convention (Convention)

• parent (SimulationNormalisation)

Methods

__init__(convention, parent)
set_all_references()	Set reference value manually
set_betaref()	Set the reference beta to the physical value
set_bref()	Set the reference magnetic field to the physical value
set_kinetic_references()	Set the reference temperature, density, mass, velocity to the physical value
set_lref()	Set the reference length to the physical value
set_rhoref()

Attributes

beta	Returns the magnetic beta if all the reference quantites are set, otherwise zero
references

property beta

Returns the magnetic beta if all the reference quantites are set, otherwise zero

property references

set_all_references()

Set reference value manually

set_betaref()

Set the reference beta to the physical value

set_bref()

Set the reference magnetic field to the physical value

set_kinetic_references()

Set the reference temperature, density, mass, velocity to the physical value

set_lref()

Set the reference length to the physical value

set_rhoref()