darsia.BeckmannConvergenceCriteria#

class BeckmannConvergenceCriteria(num_iter=100, tol_increment=1.7976931348623157e+308, tol_distance=1.7976931348623157e+308, tol_residual=1.7976931348623157e+308)[source]#

Bases: object

Class to store and check the convergence criteria for the Beckmann problem.

Methods

check_convergence_status(iter, increment, ...)

Check if convergence criteria are met.

Attributes

`num_iter`	Maximum number of iterations.
`tol_distance`	Tolerance for the distance increment.
`tol_increment`	Tolerance for the increment vector.
`tol_residual`	Tolerance for the residual.

check_convergence_status(iter, increment, distance_increment, residual)[source]#: Check if convergence criteria are met.

num_iter = 100#: Maximum number of iterations.

tol_distance = 1.7976931348623157e+308#: Tolerance for the distance increment.

tol_increment = 1.7976931348623157e+308#: Tolerance for the increment vector.

tol_residual = 1.7976931348623157e+308#: Tolerance for the residual.