implementations.convergence_controller_classes.estimate_contraction_factor module¶

class EstimateContractionFactor(controller, params, description, **kwargs)[source]¶

Bases: ConvergenceController

Estimate the contraction factor by using the evolution of the embedded error estimate across iterations.

dependencies(controller, description, **kwargs)[source]¶

Load estimator of embedded error.

Parameters:

controller (pySDC.Controller) – The controller
description (dict) – The description object used to instantiate the controller

Returns:

None

post_iteration_processing(controller, S, **kwargs)[source]¶

Estimate contraction factor here as the ratio of error estimates between iterations and estimate how many more iterations we need.

Parameters:

Returns:

None

pre_iteration_processing(controller, S, **kwargs)[source]¶

Store the embedded error estimate of the current iteration in a different place so it doesn’t get overwritten.

Parameters:

Returns:

None

reset_status_variables(controller, **kwargs)[source]¶

Reinitialize new status variables for the levels.

setup(controller, params, description, **kwargs)[source]¶

Add a default value for control order to the parameters.

Parameters:

controller (pySDC.Controller) – The controller
params (dict) – Parameters for the convergence controller
description (dict) – The description object used to instantiate the controller

Returns:

Updated parameters

Return type:

dict

setup_status_variables(controller, **kwargs)[source]¶

Add the embedded error, contraction factor and iterations to convergence variable to the status of the levels.