← Back to updatecouplingparametermethod
UpdateCouplingParameterMethod_OnlyInitialMultipliers¶
Initial-multiplier-only coupling parameter update method.
This module implements an update strategy that performs no multiplier or weight updates and only provides the initial Lagrange multiplier value. Used by subsystems (e.g. SBDP) that recover the coordination multipliers themselves (e.g. from the KKT system) but still need a seed value for the initial multipliers.
Classes¶
UpdateCouplingParameterMethod_OnlyInitialMultipliers¶
Inherits from: UpdateCouplingParameterMethodInterface
Update method that only provides the initial Lagrange multiplier value.
All update and weight operations are no-ops; only get_InitialMultiplier returns a meaningful value. Intended for coordination methods that manage the coordination multipliers externally but require a seed value.
Attributes:
_initialmultiplier: Initial value for Lagrange multipliers.
Methods¶
init(self, initialmultiplier: float) → None
Initialize the initial-multiplier-only update method.
Args:
initialmultiplier: Initial value for Lagrange multipliers.
validate_inputs(self) → None
Validate the hyperparameters of this update method.
Raises:
ValueError: If any parameter is outside the allowed range.
update_CoordinationMultipliers(self, multiplierin: List[float], inconsistencyin: List[float]) → None
No-op: does not update multipliers.
Args:
multiplierin: Current multiplier values.
inconsistencyin: Current inconsistency values.
update_CoordinationWeights(self, weightin: List[float], inconsistencyIn: List[float], inconsistencyOldIn: List[float] | None) → None
No-op: does not update weights.
Args:
weightin: Current penalty weights.
inconsistencyIn: Current inconsistency values.
inconsistencyOldIn: Previous inconsistency values, or None.
get_InitialWeight(self) → float
No-op: this method does not provide an initial weight.
Returns:
None; this no-op method does not provide an initial weight.
get_InitialMultiplier(self) → float
Get the initial Lagrange multiplier value.
Returns:
The initial Lagrange multiplier value.
print_startup_summary(self) → None
Print the initial multiplier value at startup.
print_termination_summary(self) → None
Print the initial multiplier value at the end.
update_state(self, other: UpdateCouplingParameterMethod_OnlyInitialMultipliers) → None
Update the state of this instance with values from another instance.
Args:
other: The source instance containing updated values from parallel execution.