LoadFlowParameters: simul_shunt -> shunt_compensator_voltage_control_on

Signed-off-by: Damien Jeandemange <damien.jeandemange@artelys.com>

cpp/src/bindings.cpp

@@ -420,7 +420,7 @@ PYBIND11_MODULE(_pypowsybl, m) {
             .def_readwrite("no_generator_reactive_limits", &pypowsybl::LoadFlowParameters::no_generator_reactive_limits)
             .def_readwrite("phase_shifter_regulation_on", &pypowsybl::LoadFlowParameters::phase_shifter_regulation_on)
             .def_readwrite("twt_split_shunt_admittance", &pypowsybl::LoadFlowParameters::twt_split_shunt_admittance)
-            .def_readwrite("simul_shunt", &pypowsybl::LoadFlowParameters::simul_shunt)
+            .def_readwrite("shunt_compensator_voltage_control_on", &pypowsybl::LoadFlowParameters::shunt_compensator_voltage_control_on)
             .def_readwrite("read_slack_bus", &pypowsybl::LoadFlowParameters::read_slack_bus)
             .def_readwrite("write_slack_bus", &pypowsybl::LoadFlowParameters::write_slack_bus)
             .def_readwrite("distributed_slack", &pypowsybl::LoadFlowParameters::distributed_slack)

cpp/src/pypowsybl-api.h

@@ -47,7 +47,7 @@ typedef struct loadflow_parameters_struct {
     unsigned char no_generator_reactive_limits;
     unsigned char phase_shifter_regulation_on;
     unsigned char twt_split_shunt_admittance;
-    unsigned char simul_shunt;
+    unsigned char shunt_compensator_voltage_control_on;
     unsigned char read_slack_bus;
     unsigned char write_slack_bus;
     unsigned char distributed_slack;

cpp/src/pypowsybl.cpp

@@ -322,7 +322,7 @@ LoadFlowParameters::LoadFlowParameters(loadflow_parameters* src) {
     no_generator_reactive_limits = (bool) src->no_generator_reactive_limits;
     phase_shifter_regulation_on = (bool) src->phase_shifter_regulation_on;
     twt_split_shunt_admittance = (bool) src->twt_split_shunt_admittance;
-    simul_shunt = (bool) src->simul_shunt;
+    shunt_compensator_voltage_control_on = (bool) src->shunt_compensator_voltage_control_on;
     read_slack_bus = (bool) src->read_slack_bus;
     write_slack_bus = (bool) src->write_slack_bus;
     distributed_slack = (bool) src->distributed_slack;
@@ -340,7 +340,7 @@ void LoadFlowParameters::load_to_c_struct(loadflow_parameters& res) const {
     res.no_generator_reactive_limits = (unsigned char) no_generator_reactive_limits;
     res.phase_shifter_regulation_on = (unsigned char) phase_shifter_regulation_on;
     res.twt_split_shunt_admittance = (unsigned char) twt_split_shunt_admittance;
-    res.simul_shunt = (unsigned char) simul_shunt;
+    res.shunt_compensator_voltage_control_on = (unsigned char) shunt_compensator_voltage_control_on;
     res.read_slack_bus = (unsigned char) read_slack_bus;
     res.write_slack_bus = (unsigned char) write_slack_bus;
     res.distributed_slack = (unsigned char) distributed_slack;

cpp/src/pypowsybl.h

@@ -202,7 +202,7 @@ class LoadFlowParameters {
     bool no_generator_reactive_limits;
     bool phase_shifter_regulation_on;
     bool twt_split_shunt_admittance;
-    bool simul_shunt;
+    bool shunt_compensator_voltage_control_on;
     bool read_slack_bus;
     bool write_slack_bus;
     bool distributed_slack;

docs/user_guide/loadflow.rst

@@ -51,7 +51,7 @@ Let's have a look at the default ones:
 .. doctest::
 
     >>> lf.Parameters()
-    Parameters(voltage_init_mode=UNIFORM_VALUES, transformer_voltage_control_on=False, no_generator_reactive_limits=False, phase_shifter_regulation_on=False, twt_split_shunt_admittance=False, simul_shunt=False, read_slack_bus=True, write_slack_bus=False, distributed_slack=True, balance_type=PROPORTIONAL_TO_GENERATION_P_MAX, dc_use_transformer_ratio=True, countries_to_balance=[], connected_component_mode=<ConnectedComponentMode.MAIN: 0>, provider_parameters={})
+    Parameters(voltage_init_mode=UNIFORM_VALUES, transformer_voltage_control_on=False, no_generator_reactive_limits=False, phase_shifter_regulation_on=False, twt_split_shunt_admittance=False, shunt_compensator_voltage_control_on=False, read_slack_bus=True, write_slack_bus=False, distributed_slack=True, balance_type=PROPORTIONAL_TO_GENERATION_P_MAX, dc_use_transformer_ratio=True, countries_to_balance=[], connected_component_mode=<ConnectedComponentMode.MAIN: 0>, provider_parameters={})
 
 For more details on each parameter, please refer to the :doc:`API reference </reference/loadflow/parameters>`.
 

java/src/main/java/com/powsybl/python/commons/PyPowsyblApiHeader.java

@@ -208,11 +208,11 @@ public interface LoadFlowParametersPointer extends PointerBase {
         @CField("twt_split_shunt_admittance")
         void setTwtSplitShuntAdmittance(boolean twtSplitShuntAdmittance);
 
-        @CField("simul_shunt")
-        boolean isSimulShunt();
+        @CField("shunt_compensator_voltage_control_on")
+        boolean isShuntCompensatorVoltageControlOn();
 
-        @CField("simul_shunt")
-        void setSimulShunt(boolean simulShunt);
+        @CField("shunt_compensator_voltage_control_on")
+        void setShuntCompensatorVoltageControlOn(boolean shuntCompensatorVoltageControlOn);
 
         @CField("read_slack_bus")
         boolean isReadSlackBus();

java/src/main/java/com/powsybl/python/loadflow/LoadFlowCFunctions.java

@@ -140,7 +140,7 @@ public static void copyToCLoadFlowParameters(LoadFlowParameters parameters, Load
         cParameters.setNoGeneratorReactiveLimits(parameters.isNoGeneratorReactiveLimits());
         cParameters.setPhaseShifterRegulationOn(parameters.isPhaseShifterRegulationOn());
         cParameters.setTwtSplitShuntAdmittance(parameters.isTwtSplitShuntAdmittance());
-        cParameters.setSimulShunt(parameters.isSimulShunt());
+        cParameters.setShuntCompensatorVoltageControlOn(parameters.isShuntCompensatorVoltageControlOn());
         cParameters.setReadSlackBus(parameters.isReadSlackBus());
         cParameters.setWriteSlackBus(parameters.isWriteSlackBus());
         cParameters.setDistributedSlack(parameters.isDistributedSlack());

java/src/main/java/com/powsybl/python/loadflow/LoadFlowCUtils.java

@@ -68,7 +68,7 @@ public static LoadFlowParameters convertLoadFlowParameters(boolean dc,
                 .setNoGeneratorReactiveLimits(loadFlowParametersPtr.isNoGeneratorReactiveLimits())
                 .setPhaseShifterRegulationOn(loadFlowParametersPtr.isPhaseShifterRegulationOn())
                 .setTwtSplitShuntAdmittance(loadFlowParametersPtr.isTwtSplitShuntAdmittance())
-                .setShuntCompensatorVoltageControlOn(loadFlowParametersPtr.isSimulShunt())
+                .setShuntCompensatorVoltageControlOn(loadFlowParametersPtr.isShuntCompensatorVoltageControlOn())
                 .setReadSlackBus(loadFlowParametersPtr.isReadSlackBus())
                 .setWriteSlackBus(loadFlowParametersPtr.isWriteSlackBus())
                 .setDistributedSlack(loadFlowParametersPtr.isDistributedSlack())

pypowsybl/_pypowsybl.pyi

@@ -374,7 +374,7 @@ class LoadFlowParameters:
     no_generator_reactive_limits: bool
     phase_shifter_regulation_on: bool
     read_slack_bus: bool
-    simul_shunt: bool
+    shunt_compensator_voltage_control_on: bool
     transformer_voltage_control_on: bool
     twt_split_shunt_admittance: bool
     voltage_init_mode: VoltageInitMode

pypowsybl/loadflow/impl/parameters.py

@@ -45,7 +45,7 @@ class Parameters:  # pylint: disable=too-few-public-methods
         twt_split_shunt_admittance: Split shunt admittance of transformers on both sides.
             Change the modelling of transformer legs. If you want to split the conductance and the susceptance in two,
             one at each side of the serie impedance, use ``True``.
-        simul_shunt: Simulate voltage control of shunt compensators.
+        shunt_compensator_voltage_control_on: Simulate voltage control of shunt compensators.
         read_slack_bus: Read slack bus from the network.
             The slack bus needs to be defined through a dedicate extension. Prefer ``False`` if you want to use
             your loadflow provider selection mechanism, typically the most meshed bus.
@@ -72,7 +72,7 @@ def __init__(self, voltage_init_mode: VoltageInitMode = None,
                  no_generator_reactive_limits: bool = None,
                  phase_shifter_regulation_on: bool = None,
                  twt_split_shunt_admittance: bool = None,
-                 simul_shunt: bool = None,
+                 shunt_compensator_voltage_control_on: bool = None,
                  read_slack_bus: bool = None,
                  write_slack_bus: bool = None,
                  distributed_slack: bool = None,
@@ -92,8 +92,8 @@ def __init__(self, voltage_init_mode: VoltageInitMode = None,
             self.phase_shifter_regulation_on = phase_shifter_regulation_on
         if twt_split_shunt_admittance is not None:
             self.twt_split_shunt_admittance = twt_split_shunt_admittance
-        if simul_shunt is not None:
-            self.simul_shunt = simul_shunt
+        if shunt_compensator_voltage_control_on is not None:
+            self.shunt_compensator_voltage_control_on = shunt_compensator_voltage_control_on
         if read_slack_bus is not None:
             self.read_slack_bus = read_slack_bus
         if write_slack_bus is not None:
@@ -117,7 +117,7 @@ def _init_from_c(self, c_parameters: LoadFlowParameters) -> None:
         self.no_generator_reactive_limits = c_parameters.no_generator_reactive_limits
         self.phase_shifter_regulation_on = c_parameters.phase_shifter_regulation_on
         self.twt_split_shunt_admittance = c_parameters.twt_split_shunt_admittance
-        self.simul_shunt = c_parameters.simul_shunt
+        self.shunt_compensator_voltage_control_on = c_parameters.shunt_compensator_voltage_control_on
         self.read_slack_bus = c_parameters.read_slack_bus
         self.write_slack_bus = c_parameters.write_slack_bus
         self.distributed_slack = c_parameters.distributed_slack
@@ -138,7 +138,7 @@ def _to_c_parameters(self) -> LoadFlowParameters:
         c_parameters.no_generator_reactive_limits = self.no_generator_reactive_limits
         c_parameters.phase_shifter_regulation_on = self.phase_shifter_regulation_on
         c_parameters.twt_split_shunt_admittance = self.twt_split_shunt_admittance
-        c_parameters.simul_shunt = self.simul_shunt
+        c_parameters.shunt_compensator_voltage_control_on = self.shunt_compensator_voltage_control_on
         c_parameters.read_slack_bus = self.read_slack_bus
         c_parameters.write_slack_bus = self.write_slack_bus
         c_parameters.distributed_slack = self.distributed_slack
@@ -157,7 +157,7 @@ def __repr__(self) -> str:
                f", no_generator_reactive_limits={self.no_generator_reactive_limits!r}" \
                f", phase_shifter_regulation_on={self.phase_shifter_regulation_on!r}" \
                f", twt_split_shunt_admittance={self.twt_split_shunt_admittance!r}" \
-               f", simul_shunt={self.simul_shunt!r}" \
+               f", shunt_compensator_voltage_control_on={self.shunt_compensator_voltage_control_on!r}" \
                f", read_slack_bus={self.read_slack_bus!r}" \
                f", write_slack_bus={self.write_slack_bus!r}" \
                f", distributed_slack={self.distributed_slack!r}" \

tests/test_flow_decomposition.py

@@ -19,8 +19,8 @@ def define_test_load_flow_parameters():
         transformer_voltage_control_on=False, 
         no_generator_reactive_limits=False, 
         phase_shifter_regulation_on=False, 
-        twt_split_shunt_admittance=False, 
-        simul_shunt=False, 
+        twt_split_shunt_admittance=False,
+        shunt_compensator_voltage_control_on=False,
         read_slack_bus=True, 
         write_slack_bus=False, 
         distributed_slack=True, 

tests/test_loadflow.py

@@ -63,7 +63,7 @@ def test_lf_parameters():
         'no_generator_reactive_limits': [True, False],
         'phase_shifter_regulation_on': [True, False],
         'twt_split_shunt_admittance': [True, False],
-        'simul_shunt': [True, False],
+        'shunt_compensator_voltage_control_on': [True, False],
         'read_slack_bus': [True, False],
         'write_slack_bus': [True, False],
         'distributed_slack': [True, False],