model.HydrostaticEquilibrium.correct#
- HydrostaticEquilibrium.correct(mode='minimal')#
Correct the
model.ClusterModel
instance. Themode
kwarg may be used to determine the precise algorithm that is used to complete the correction.- Parameters:
mode (
str
) – The algorithm to use for correction. Options areminimal
andsmooth
. Ifminimal
, then the dynamical density is replaced with the minimum allowed consistent value but may lack smoothness. Ifsmooth
, then a smooth monotone interpolation scheme is used.- Return type: