PlasmaCalcs.addons.instability_tools.instability_theory_tools.xarray_klims_physical

PlasmaCalcs.addons.instability_tools.instability_theory_tools.xarray_klims_physical(ds, *, to_simple=False)

return copy of dataset, but also having the physical values limiting k.

if ds has ‘ldebye’, result[‘kdebye’] = 2*pi/ldebye.

if ds has ‘lmfp’, result[‘kmfp’] = 2*pi/lmfp.

(similarly, recognizes ‘eqperp_ldebye’ and ‘eqperp_lmfp’;

result keys would be ‘eqperp_kdebye’ and ‘eqperp_kmfp’.)

if result does not have anything to indicate any klims_physical in it, raise InputError.

to_simple: bool

whether to instead return result as a dict containing:

(if any debye length specifiers exist in ds):

‘kdebye_lim’: result[kdebye var]

‘kdebye_var’: kdebye var name

(if any mean free path specifiers exist in ds):

‘kmfp_lim’: result[kmfp var]

‘kmfp_var’: kmfp var name

In this case, if multiple specifiers exist, crash.