nifty8.minimization.minimizer module#

class Minimizer[source]#

Bases: object

A base class used by all minimizers.

__call__(energy, preconditioner=None)[source]#

Performs the minimization of the provided Energy functional.

Parameters:

energy (Energy) – Energy object at the starting point of the iteration
preconditioner (LinearOperator, optional) – Preconditioner to accelerate the minimization

Returns:

Energy (Latest energy of the minimization.)
int (exit status of the minimization) – Can be controller.CONVERGED or controller.ERROR