gemseo / algos / sequence_transformer / relaxation

Show inherited members

over_relaxation module

The over-relaxation method.

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

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].

property factor: float

The over-relaxation factor.