CoordinationMethodBasis¶

Source: Distributed_Design_Optimizer/coordination/coordinationmethod/CoordinationMethodBasis.py

Basis class for coordination methods.

This module provides the base implementation for coordination methods, containing common functionality shared across different coordination algorithms.

Classes¶

CoordinationMethodBasis¶

Inherits from: CoordinationMethodInterface

Basis class for coordination methods providing common functionality.

This class implements the common getter methods for iteration schemes that are shared across all coordination method implementations. Subclasses must set the iteration scheme attributes in their init.

Methods¶

init(self) → None

Initialize the basis class.

Note: Subclasses must set the following attributes: - _iterationscheme: IterationSchemeInterface - _allowediterationschemes: List[Type[IterationSchemeInterface]] - _unrecommendediterationschemes: List[Type[IterationSchemeInterface]] - _recommendediterationschemes: List[Type[IterationSchemeInterface]]

get_IterationScheme(self) → IterationSchemeInterface

Get the selected iteration scheme.

Returns:

The iteration scheme instance.

get_AllowedIterationSchemes(self) → List[Type[IterationSchemeInterface]]

Get the list of allowed iteration scheme types.

Returns:

List of iteration scheme class types compatible with this coordination method.

get_UnrecommendedIterationSchemes(self) → List[Type[IterationSchemeInterface]]

Get the list of unrecommended iteration scheme types.

Returns:

List of iteration scheme class types that are unrecommended.

get_RecommendedIterationSchemes(self) → List[Type[IterationSchemeInterface]]

Get the list of recommended iteration scheme types.

Returns:

List of iteration scheme class types recommended for best convergence.

get_Convergence_Indicator_Innerloop(self) → ConvergenceIndicator_Innerloop_Interface

Get the inner loop convergence indicator factory.

Returns:

ConvergenceIndicator_Innerloop_Interface: The convergence indicator for inner loop.

get_Convergence_Indicator_Outerloop(self) → ConvergenceIndicator_Outerloop_Interface

Get the outer loop convergence indicator factory.

Returns:

ConvergenceIndicator_Outerloop_Interface: The convergence indicator for outer loop.

print_startup_summary(self) → None

Print the convergence indicators, update method, and iteration scheme at startup.

print_termination_summary(self) → None

Print the convergence indicators, update method, and iteration scheme at the end.