LocalSubSystemHistoryEntry¶

Source: Distributed_Design_Optimizer/subsystem/historyentry/LocalSubSystemHistoryEntry.py

Local subsystem history entry module.

This module provides the history log entry for a local subsystem, extending the subsystem history entry with scaler and inconsistency snapshots.

Classes¶

LocalSubSystemHistoryEntry¶

Inherits from: SubSystemHistoryEntry

History log entry for a local subsystem.

Extends SubSystemHistoryEntry with the scalers, inconsistencies and maximum inconsistency information that only exist for local subsystems.

Methods¶

init(self, subsystem_id: str, outerloop_itr: int, innerloop_itr: int, innerloop_itr_runtime: float | None, innerloop_itr_numberofdesignvariableevaluations: int | None, optimdata: LocalSubSystemOptimData, convinnerloop: bool, convouterloop: bool, scalers: List[ScalerBasis], inconsistencies: List[InConsistencySizeInterface], maxinconsistencyvalue: float | None, maxinconsistencysubsystemID: str | None) → None

Create a new LocalSubSystemHistoryEntry.

Args:

subsystem_id: Identifier of the subsystem this snapshot belongs to.
outerloop_itr: Outer loop iteration number of this snapshot.
innerloop_itr: Inner loop iteration number of this snapshot.
innerloop_itr_runtime: Runtime of the inner loop iteration.
innerloop_itr_numberofdesignvariableevaluations: Number of design
variable evaluations of the inner loop iteration.
optimdata: Snapshot of the subsystem's optimization data.
convinnerloop: Inner loop convergence flag.
convouterloop: Outer loop convergence flag.
scalers: Snapshot of the subsystem's scalers.
inconsistencies: Snapshot of the subsystem's inconsistencies.
maxinconsistencyvalue: Maximum inconsistency value of this snapshot.
maxinconsistencysubsystemID: Identifier of the coupled subsystem with
the maximum inconsistency.

get_OptimData(self) → LocalSubSystemOptimData

Return the snapshot of the subsystem's optimization data.

Returns:

The local subsystem optimization data of this snapshot.

get_Scalers(self) → List[ScalerBasis]

Return the snapshot of the subsystem's scalers.

Returns:

The list of scalers of this snapshot.

get_Inconsistencies(self) → List[InConsistencySizeInterface]

Return the snapshot of the subsystem's inconsistencies.

Returns:

The list of inconsistencies of this snapshot.

get_maxInconsistencyValue(self) → float | None

Return the maximum inconsistency value of this snapshot.

Returns:

The maximum inconsistency value, or None if not set.

get_MaxInconsistencyCoupledSubsystemID(self) → str | None

Return the coupled subsystem identifier with the maximum inconsistency.

Returns:

The coupled subsystem identifier, or None if not set.