krakentools.groupconstants.mod5.getters.get_diffcoef

krakentools.groupconstants.mod5.getters.get_diffcoef(hg_uni, dc_to_get, dc_type)

Obtains the requested diffusion coefficient from a HomogUniv object

Parameters:

  • data (hg_uni {HomogUniv} -- HomogUniv object containing .coe and/or _res.m) –

  • get (dc_to_get {MOD5GroupConstants} -- The diffusion coefficient to) – Should be either MOD5GroupConstants.DIFF1 or MOD5GroupConstants.DIFF2

  • get. (dc_type {DCTypes} -- The type of diffusion coefficient to) –

Raises:

KeyError – For unknown diffusion coefficient types.

Return type:

float

Returns:

float – Requested diffusion coefficient (cm)