InputFile¶

Source: userfiles/NewUseCase_Template/InputFile.py

Input file configuration template for new use-cases.

This module defines the InputFile class which serves as a template for configuring all parameters for a distributed optimization problem. It demonstrates how to set up subsystem definitions, coordination methods, iteration schemes, coupling parameters, and scaling variables.

Classes¶

InputFile¶

Inherits from: InputFileBasis

Template input file for distributed optimization.

Configures a three-subsystem distributed optimization problem by defining the coordination method, subsystem hierarchy, design variable bounds, scaling variables, initial design variables, and coupling parameters.

Attributes:

_name: Identifier string for this use-case.
_coordinationmethod: The coordination algorithm (e.g. ALC, PC, LC).
_subsystems: List of LocalSubSystemBasis instances created by the
coordination method.

Methods¶

init(self) → None

Initialize the distributed optimization problem configuration.

Sets up the full problem definition including: 1. Coordination method and its hyperparameters. 2. Subsystem IDs, hierarchy levels, and neighbor relationships. 3. Analysis, objective, constraint, and optimization instances for each subsystem. 4. Design variable bounds and scaling. 5. Initial design variable values. 6. Coupling and shared design variable initialization between neighboring subsystems.