gemseo / algos / sequence_transformer / composite

Hide inherited members

relaxation_acceleration module

The over-relaxation method.

class gemseo.algos.sequence_transformer.composite.relaxation_acceleration.RelaxationAcceleration(over_relaxation_factor=1.0, acceleration_method=AccelerationMethod.NONE)

Bases: CompositeSequenceTransformer

A composite made up of a relaxation followed by an acceleration.

Parameters:

• over_relaxation_factor (float) –

  The over-relaxation factor.

  By default it is set to 1.0.

• acceleration_method (AccelerationMethod) –

  The acceleration method to be used to improve the convergence rate of the fixed point iteration method.

  By default it is set to “NoTransformation”.

clear()

Clear the iterates in the double-ended queues.

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 acceleration_method: AccelerationMethod

The acceleration method.

property over_relaxation_factor: float

The over-relaxation factor.