polaris.ocean.convergence.analysis.ConvergenceAnalysis.convergence_parameters

ConvergenceAnalysis.convergence_parameters(field_name=None)

Get convergence parameters

Parameters:

field_name (str) – The name of the variable of which we evaluate convergence For the default method, we use the same convergence rate for all fields

Returns:

• conv_thresh (float) – The minimum convergence rate

• error_type ({‘l2’, ‘inf’}, str) – The error norm to compute