InputFileBasis¶

Source: Distributed_Design_Optimizer/coordination/InputFileBasis.py

Basis implementation of the InputFile interface for coordination setup.

Classes¶

InputFileBasis¶

Inherits from: InputFileInterface

Base class providing the standard InputFile configuration for coordination.

Methods¶

init(self) → None

📐 Pseudocode: Require hyperparameters and initial coupling parameters (Lines 1, 2, 3) → Unified Algorithmic Structure

Initialize the input file basis with default None values.

get_Subsystems(self) → List[LocalSubSystemBasis]

Return the list of local subsystems.

Returns:

The list of local subsystem basis instances.

get_CoordinationMethod(self) → CoordinationMethodInterface

Return the coordination method.

Returns:

The coordination method interface instance.

get_IterationScheme(self) → IterationSchemeInterface

Return the iteration scheme.

Returns:

The iteration scheme interface instance.

get_Name(self) → str

Return the name of the input file configuration.

Returns:

The name identifier string.

get_HistoryFolderPath(self) → str

Return the folder path where history .dill files are saved.

The path is derived from the source-file location of the concrete InputFile subclass (type(self)), which resides in the use-case folder under userfiles//. This anchors the historyfiles folder to the use-case rather than the current working directory, independent of where the use-case's main.py is launched from.

Returns:

The absolute path to the use-case's historyfiles folder.

print_startup_summary(self) → None

Print the input file configuration summary.