pyrokinetics.diagnostics.saturation_rules.SaturationRules

pyrokinetics.diagnostics.saturation_rules.SaturationRules#

class pyrokinetics.diagnostics.saturation_rules.SaturationRules(pyro_scan)[source]#

Bases: object

Contains all the different saturation rules that can be applied

Need a PyroScan object to apply the rule to

Parameters:

pyro_scan (PyroScan)

__init__(pyro_scan)[source]#
Parameters:

pyro_scan (PyroScan)

Methods

__init__(pyro_scan)

mg_saturation([Q0, alpha, gamma_exb, ...])

Please see doi:10.1017/S0022377824001107 for details on this quasi-linear model.
mg_saturation(Q0=25.0, alpha=2.5, gamma_exb=0.0, output_convention='pyrokinetics', gamma_tolerance=0.001, ky_dim='ky', theta0_dim='theta0')[source]#

Please see doi:10.1017/S0022377824001107 for details on this quasi-linear model.

Parameters:

  • Q0 (float) – Heat flux absolute magnitude from fitted model

  • alpha (float) – Power to raise QL metric Lambda

  • gamma_exb (float) – Rate of ExB shear. Note must be in units matching output_convention

  • output_convention (str) – Choice of output convention

  • gamma_tolerance (float) – Tolerance of growth rate to be included in calculation

  • ky_dim (str) – Name of the dimension in PyroScan object corresponding to ky

  • theta0_dim (str) – Name of the dimension in PyroScan object corresponding to theta0

Returns:

gk_output – Dataset containing heat and particle flux with dimensions of Species and other in original PyroScan object

Return type:

xr.Dataset

Contents