-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor voltage initializer module (#710)
Signed-off-by: Etienne LESOT <[email protected]>
- Loading branch information
Showing
4 changed files
with
182 additions
and
167 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
122 changes: 122 additions & 0 deletions
122
pypowsybl/voltage_initializer/impl/voltage_initializer_parameters.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| # Copyright (c) 2023, RTE (http://www.rte-france.com) | ||
| # This Source Code Form is subject to the terms of the Mozilla Public | ||
| # License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| # file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| # SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| from typing import Dict, List, Tuple | ||
| from pypowsybl._pypowsybl import ( | ||
| create_voltage_initializer_params, | ||
| voltage_initializer_add_variable_shunt_compensators, | ||
| voltage_initializer_add_constant_q_generators, | ||
| voltage_initializer_add_variable_two_windings_transformers, | ||
| voltage_initializer_add_specific_low_voltage_limits, | ||
| voltage_initializer_add_specific_high_voltage_limits, | ||
| VoltageInitializerObjective, | ||
| voltage_initializer_set_objective, | ||
| voltage_initializer_set_objective_distance) | ||
|
|
||
|
|
||
| class VoltageInitializerParameters: | ||
| """ | ||
| Parameters of a voltage initializer run. | ||
| """ | ||
|
|
||
| def __init__(self) -> None: | ||
| self._handle = create_voltage_initializer_params() | ||
|
|
||
| def add_variable_shunt_compensators(self, shunt_id_list: List[str]) -> None: | ||
| """ | ||
| Indicate to voltage initializer that the given shunt compensator has a variable susceptance. | ||
| Args: | ||
| shunt_id_list: List of shunt ids. | ||
| """ | ||
| for shunt_id in shunt_id_list: | ||
| voltage_initializer_add_variable_shunt_compensators(self._handle, shunt_id) | ||
|
|
||
| def add_constant_q_generators(self, generator_id_list: List[str]) -> None: | ||
| """ | ||
| Indicate to voltage initializer that the given generator have a constant target reactive power. | ||
| Args: | ||
| generator_id_list: List of generator ids. | ||
| """ | ||
| for generator_id in generator_id_list: | ||
| voltage_initializer_add_constant_q_generators(self._handle, generator_id) | ||
|
|
||
| def add_variable_two_windings_transformers(self, transformer_id_list: List[str]) -> None: | ||
| """ | ||
| Indicate to voltage initializer that the given 2wt have a variable ratio. | ||
| Args: | ||
| transformer_id_list: List of transformer ids. | ||
| """ | ||
| for transformer_id in transformer_id_list: | ||
| voltage_initializer_add_variable_two_windings_transformers(self._handle, transformer_id) | ||
|
|
||
| def add_specific_low_voltage_limits(self, low_limits: List[Tuple[str, bool, float]]) -> None: | ||
| """ | ||
| Indicate to voltage initializer to override the network low voltages limits, | ||
| limit can be given relative to former limit or absolute. | ||
| High limits can be given for the same voltage level ids using | ||
| :func:`~VoltageInitializerParameters.add_specific_high_voltage_limits` | ||
| but it is not necessary to give a high limit as long as each voltage level has its limits | ||
| defined and consistent after overrides (low limit < high limit, low limit > 0...) | ||
| Use this if voltage initializer cannot converge because of infeasibility. | ||
| Args: | ||
| low_limits: A List with elements as (voltage level id, is limit relative, limit value) | ||
| """ | ||
| for voltage_level_id, is_relative, limit in low_limits: | ||
| voltage_initializer_add_specific_low_voltage_limits(self._handle, voltage_level_id, is_relative, limit) | ||
|
|
||
| def add_specific_high_voltage_limits(self, high_limits: List[Tuple[str, bool, float]]) -> None: | ||
| """ | ||
| Indicate to voltage initializer to override the network high voltages limits, | ||
| limit can be given relative to previous limit or absolute. | ||
| Low limits can be given for the same voltage level ids using | ||
| :func:`~VoltageInitializerParameters.add_specific_low_voltage_limits` | ||
| but it is not necessary to give a low limit as long as each voltage level has its limits | ||
| defined and consistent after overrides (low limit < high limit, low limit > 0...) | ||
| Use this if voltage initializer cannot converge because of infeasibility. | ||
| Args: | ||
| high_limits: A List with elements as (voltage level id, is limit relative, limit value) | ||
| """ | ||
| for voltage_level_id, is_relative, limit in high_limits: | ||
| voltage_initializer_add_specific_high_voltage_limits(self._handle, voltage_level_id, is_relative, limit) | ||
|
|
||
| def add_specific_voltage_limits(self, limits: Dict[str, Tuple[float, float]]) -> None: | ||
| """ | ||
| Indicate to voltage initializer to override the network voltages limits. | ||
| Limits are given relative to previous limits. | ||
| Use this if voltage initializer cannot converge because of infeasibility. | ||
| Args: | ||
| limits: A dictionary keys are voltage ids, values are (lower limit, upper limit) | ||
| """ | ||
| for key in limits: | ||
| self.add_specific_low_voltage_limits([(key, True, limits[key][0])]) | ||
| self.add_specific_high_voltage_limits([(key, True, limits[key][1])]) | ||
|
|
||
| def set_objective(self, objective: VoltageInitializerObjective) -> None: | ||
| """ | ||
| If you use BETWEEN_HIGH_AND_LOW_VOLTAGE_LIMIT, you also need to call | ||
| :func:`~VoltageInitializerParameters.set_objective_distance`. | ||
| Args: | ||
| objective: objective function to set for VoltageInitializer. | ||
| """ | ||
| voltage_initializer_set_objective(self._handle, objective) | ||
|
|
||
| def set_objective_distance(self, distance: float) -> None: | ||
| """ | ||
| If you use BETWEEN_HIGH_AND_LOW_VOLTAGE_LIMIT, you also need to call this function. | ||
| Args: | ||
| distance: is in %. | ||
| A 0% objective means the model will target lower voltage limit. | ||
| A 100% objective means the model will target upper voltage limit. | ||
| """ | ||
| voltage_initializer_set_objective_distance(self._handle, distance) |
52 changes: 52 additions & 0 deletions
52
pypowsybl/voltage_initializer/impl/voltage_initializer_results.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Copyright (c) 2023, RTE (http://www.rte-france.com) | ||
| # This Source Code Form is subject to the terms of the Mozilla Public | ||
| # License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| # file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| # SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| from typing import Dict | ||
| from pypowsybl._pypowsybl import ( | ||
| VoltageInitializerStatus, | ||
| voltage_initializer_get_status, | ||
| voltage_initializer_get_indicators, | ||
| voltage_initializer_apply_all_modifications, | ||
| JavaHandle | ||
| ) | ||
| from pypowsybl.network import Network | ||
|
|
||
|
|
||
| class VoltageInitializerResults: | ||
| """ | ||
| Results of a voltage initializer run. | ||
| """ | ||
|
|
||
| def __init__(self, result_handle: JavaHandle) -> None: | ||
| self._handle = result_handle | ||
| self._status: VoltageInitializerStatus = voltage_initializer_get_status(self._handle) | ||
| self._indicators: Dict[str, str] = voltage_initializer_get_indicators(self._handle) | ||
|
|
||
| def apply_all_modifications(self, network: Network) -> None: | ||
| """ | ||
| Apply all the modifications voltage initializer found to the network. | ||
| Args: | ||
| network: the network on which the modifications are to be applied. | ||
| """ | ||
| voltage_initializer_apply_all_modifications(self._handle, network._handle) | ||
|
|
||
| @property | ||
| def status(self) -> VoltageInitializerStatus: | ||
| """ | ||
| If the optimisation failed, it can be useful to check the indicators. | ||
| Returns: | ||
| The status of the optimisation | ||
| """ | ||
| return self._status | ||
|
|
||
| @property | ||
| def indicators(self) -> Dict[str, str]: | ||
| """ | ||
| Returns: | ||
| The indicators as a dict of the optimisation | ||
| """ | ||
| return self._indicators |