pyrokinetics.normalisation.ConventionNormalisation#
- class pyrokinetics.normalisation.ConventionNormalisation(convention, parent)[source]#
Bases:
Normalisation
A concrete set of reference values/normalisations.
You should call
set_lref
,set_bref
and thenset_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 setregistry – 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)[source]#
- Parameters:
convention (Convention)
parent (SimulationNormalisation)
Methods
__init__
(convention, parent)Set reference value manually
set_bref
()Set the reference magnetic field to the physical value
Set the reference temperature, density, mass, velocity to the physical value
set_lref
()Set the reference length to the physical value
Attributes
Returns the magnetic beta if all the reference quantites are set, otherwise zero
- property beta#
Returns the magnetic beta if all the reference quantites are set, otherwise zero
- property references#