gemseo / algos / sequence_transformer / relaxation

Hide inherited members

over_relaxation module

The over-relaxation method.

class gemseo.algos.sequence_transformer.relaxation.over_relaxation.OverRelaxation(factor=1.0)

Bases: SequenceTransformer

The over relaxation method.

Parameters:

factor (float) –

The relaxation factor lying within ]0, 2].

By default it is set to 1.0.

Raises:

ValueError if the provided relaxation factor lies outside ]0, 2]. –

clear()

Clear the iterates.

Return type:

None

compute_transformed_iterate(iterate, residual)

Compute the next transformed iterate.

Parameters:

• iterate (NDArray) – The iterate \(G(x_n)\).

• residual (NDArray) – The associated residual \(G(x_n) - x_n\).

Returns:

The next transformed iterate \(x_{n+1}\).

Return type:

NDArray

property factor: float

The over-relaxation factor.