← Back to aladin
ControllerToLocalCouplingParameters¶
Controller to local coupling parameters module.
This module provides parameters for coupling from controller to local subsystems in ALADIN.
Classes¶
ControllerToLocalCouplingParameters¶
This class is a part of the controller mapping between controller and local subsystem.
It handles the communicated data that has an assignment to i <-> j pairs.
Methods¶
init(self, id: str) → None
Initialize controller to local coupling parameters.
Args:
id: Identifier of the local subsystem j to which subsystem i is coupled.
get_ID(self) → str
Return the ID.
Returns:
The identifier of the coupled local subsystem.
update_state(self, other_coupling: ControllerToLocalCouplingParameters) → None
Update the state of this object from another ControllerToLocalCouplingParameters.
This method is necessary for multiprocessing: when subsystems are executed in parallel via Parallel.py using multiprocessing.Pool, each process receives a copy of the data. After execution, the original objects must be updated with results from the executed copies. This method updates the numerical information stored in the class's attributes without changing the original memory address location, preserving object identity.
Attributes are updated in the same order as defined in init().
Args:
other_coupling: Source instance to copy state from.