Export buses voltage and update targets V

open-reac/src/main/java/com/powsybl/openreac/parameters/OpenReacAmplIOFiles.java

@@ -14,6 +14,7 @@
 import com.powsybl.openreac.parameters.input.algo.AlgorithmInput;
 import com.powsybl.openreac.parameters.output.OpenReacResult;
 import com.powsybl.openreac.parameters.output.ReactiveSlackOutput;
+import com.powsybl.openreac.parameters.output.VoltagePlanOutput;
 import com.powsybl.openreac.parameters.output.network.NetworkModifications;
 
 import java.util.ArrayList;
@@ -40,6 +41,7 @@ public class OpenReacAmplIOFiles implements AmplParameters {
     private final VoltageLevelLimitsOverrideInput voltageLimitsOverride;
     private final ConfiguredBusesWithReactiveSlack configuredReactiveSlackBuses;
     private final NetworkModifications networkModifications;
+    private final VoltagePlanOutput voltagePlanOutput;
     private final boolean debug;
 
     public OpenReacAmplIOFiles(OpenReacParameters params, Network network, boolean debug) {
@@ -54,6 +56,7 @@ public OpenReacAmplIOFiles(OpenReacParameters params, Network network, boolean d
         //outputs
         this.reactiveSlackOutput = new ReactiveSlackOutput();
         this.networkModifications = new NetworkModifications(network);
+        this.voltagePlanOutput = new VoltagePlanOutput();
 
         this.debug = debug;
     }
@@ -66,6 +69,10 @@ public NetworkModifications getNetworkModifications() {
         return networkModifications;
     }
 
+    public VoltagePlanOutput getVoltagePlanOutput() {
+        return voltagePlanOutput;
+    }
+
     @Override
     public Collection<AmplInputFile> getInputParameters() {
         return List.of(constantQGenerators, variableShuntCompensators, variableTwoWindingsTransformers,
@@ -76,9 +83,10 @@ public Collection<AmplInputFile> getInputParameters() {
     public Collection<AmplOutputFile> getOutputParameters(boolean isConvergenceOk) {
         if (isConvergenceOk) {
             List<AmplOutputFile> networkModificationsOutputFiles = networkModifications.getOutputFiles();
-            List<AmplOutputFile> list = new ArrayList<>(networkModificationsOutputFiles.size() + 1);
+            List<AmplOutputFile> list = new ArrayList<>(networkModificationsOutputFiles.size() + 2);
             list.addAll(networkModificationsOutputFiles);
             list.add(reactiveSlackOutput);
+            list.add(voltagePlanOutput);
             return list;
         }
         return List.of();

open-reac/src/main/java/com/powsybl/openreac/parameters/output/OpenReacResult.java

@@ -8,14 +8,12 @@
 
 import com.powsybl.iidm.modification.*;
 import com.powsybl.iidm.modification.tapchanger.RatioTapPositionModification;
-import com.powsybl.iidm.network.Network;
+import com.powsybl.iidm.network.*;
 import com.powsybl.openreac.parameters.OpenReacAmplIOFiles;
 import com.powsybl.openreac.parameters.output.ReactiveSlackOutput.ReactiveSlack;
+import org.jgrapht.alg.util.Pair;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
+import java.util.*;
 
 /**
  * OpenReac user interface to get results information.
@@ -32,6 +30,8 @@ public class OpenReacResult {
     private final List<VscConverterStationModification> vscModifications;
     private final List<StaticVarCompensatorModification> svcModifications;
     private final List<RatioTapPositionModification> tapPositionModifications;
+    private final HashMap<String, Pair<Double, Double>> voltagePlan;
+    private boolean warmStart = true;
 
     /**
      * @param status      the final status of the OpenReac run.
@@ -48,6 +48,7 @@ public OpenReacResult(OpenReacStatus status, OpenReacAmplIOFiles amplIOFiles, Ma
         this.vscModifications = List.copyOf(amplIOFiles.getNetworkModifications().getVscModifications());
         this.svcModifications = List.copyOf(amplIOFiles.getNetworkModifications().getSvcModifications());
         this.tapPositionModifications = List.copyOf(amplIOFiles.getNetworkModifications().getTapPositionModifications());
+        this.voltagePlan = new HashMap<>(amplIOFiles.getVoltagePlanOutput().getVoltagePlan());
     }
 
     public OpenReacStatus getStatus() {
@@ -82,7 +83,19 @@ public List<VscConverterStationModification> getVscModifications() {
         return vscModifications;
     }
 
-    public List<NetworkModification> getAllModifs() {
+    public Map<String, Pair<Double, Double>> getVoltagePlan() {
+        return voltagePlan;
+    }
+
+    public boolean getWarmStat() {
+        return warmStart;
+    }
+
+    public void setWarmStart(boolean warmStart) {
+        this.warmStart = warmStart;
+    }
+
+    public List<NetworkModification> getAllNetworkModifications() {
         List<NetworkModification> modifs = new ArrayList<>(getGeneratorModifications().size() +
             getShuntsModifications().size() +
             getSvcModifications().size() +
@@ -97,8 +110,40 @@ public List<NetworkModification> getAllModifs() {
     }
 
     public void applyAllModifications(Network network) {
-        for (NetworkModification modif : getAllModifs()) {
+        for (NetworkModification modif : getAllNetworkModifications()) {
             modif.apply(network);
         }
+
+        // update target of ratio tap changers regulating voltage
+        network.getTwoWindingsTransformerStream()
+                .filter(RatioTapChangerHolder::hasRatioTapChanger)
+                .map(RatioTapChangerHolder::getRatioTapChanger)
+                .filter(TapChanger::isRegulating)
+                .forEach(ratioTapChanger -> {
+                    Bus bus = ratioTapChanger.getRegulationTerminal().getBusView().getBus();
+                    double v = voltagePlan.get(bus.getId()).getFirst();
+                    ratioTapChanger.setTargetV(v * bus.getVoltageLevel().getNominalV());
+                }
+            );
+
+        // update target of shunts regulating voltage
+        network.getShuntCompensatorStream()
+                .filter(ShuntCompensator::isVoltageRegulatorOn)
+                .forEach(shuntCompensator -> {
+                    Bus bus = shuntCompensator.getRegulatingTerminal().getBusView().getBus();
+                    double v = voltagePlan.get(bus.getId()).getFirst();
+                    shuntCompensator.setTargetV(v * bus.getVoltageLevel().getNominalV());
+                });
+
+        // update voltages of the buses
+        if (getWarmStat()) {
+            for (var busUpdate : voltagePlan.entrySet()) {
+                Bus b = network.getBusView().getBus(busUpdate.getKey());
+                double v = busUpdate.getValue().getFirst();
+                double angle = busUpdate.getValue().getSecond();
+                b.setV(v * b.getVoltageLevel().getNominalV());
+                b.setAngle(angle);
+            }
+        }
     }
 }

open-reac/src/main/java/com/powsybl/openreac/parameters/output/VoltagePlanOutput.java

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) 2024, 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/.
+ */
+package com.powsybl.openreac.parameters.output;
+
+import com.powsybl.ampl.converter.AmplSubset;
+import com.powsybl.commons.util.StringToIntMapper;
+import com.powsybl.openreac.parameters.AmplIOUtils;
+import org.jgrapht.alg.util.Pair;
+
+import java.util.*;
+
+/**
+ * @author Pierre Arvy <pierre.arvy at artelys.com>
+ */
+public class VoltagePlanOutput extends AbstractNoThrowOutput {
+
+    private static final String ELEMENT = "voltages";
+    public static final int EXPECTED_COLS = 5;
+    private static final int ID_COLUMN_INDEX = 4;
+    private static final int V_COLUMN_INDEX = 2;
+    private static final int ANGLE_COLUMN_INDEX = 3;
+
+    private final Map<String, Pair<Double, Double>> voltagePlan = new HashMap<>();
+
+    public Map<String, Pair<Double, Double>> getVoltagePlan() {
+        return voltagePlan;
+    }
+
+    @Override
+    public String getElement() {
+        return ELEMENT;
+    }
+
+    @Override
+    public int getExpectedColumns() {
+        return EXPECTED_COLS;
+    }
+
+    @Override
+    protected void readLine(String[] tokens, StringToIntMapper<AmplSubset> stringToIntMapper) {
+        String id = AmplIOUtils.removeQuotes(tokens[ID_COLUMN_INDEX]);
+        double v = readDouble(tokens[V_COLUMN_INDEX]);
+        double angle = readDouble(tokens[ANGLE_COLUMN_INDEX]);
+        voltagePlan.put(id, Pair.of(v, angle));
+    }
+
+    @Override
+    public boolean throwOnMissingFile() {
+        triggerErrorState();
+        return false;
+    }
+
+}

open-reac/src/main/resources/openreac/reactiveopfoutput.run

@@ -190,6 +190,24 @@ close (fileOut);
 
 
 
+###############################################################################
+#
+# Writing results for buses states
+#
+###############################################################################
+if final_status == "OK" then {
+
+  let fileOut := "reactiveopf_results_voltages.csv";
+  printf "#variant;bus;V(pu);theta(rad);id;\n" > (fileOut);
+  printf {n in BUSCC} "%i;%i;%.3f;%.3f;%s;\n",
+    1, n, V[n], teta[n], '"' & bus_id[1,n] & '"'
+    > (fileOut);
+  close (fileOut);
+
+}
+
+
+
 ###############################################################################
 #
 # Writing results for LCC converters

open-reac/src/test/java/com/powsybl/openreac/OpenReacRunnerTest.java

@@ -41,8 +41,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
@@ -200,7 +199,8 @@ public void testOutputFileParsing() throws IOException {
                 "mock_outputs/reactiveopf_results_rtc.csv",
                 "mock_outputs/reactiveopf_results_shunts.csv",
                 "mock_outputs/reactiveopf_results_static_var_compensators.csv",
-                "mock_outputs/reactiveopf_results_vsc_converter_stations.csv"));
+                "mock_outputs/reactiveopf_results_vsc_converter_stations.csv",
+                "mock_outputs/reactiveopf_results_voltages.csv"));
         try (ComputationManager computationManager = new LocalComputationManager(new LocalComputationConfig(tmpDir),
             localCommandExecutor, ForkJoinPool.commonPool())) {
             OpenReacResult openReacResult = OpenReacRunner.run(network,
@@ -213,6 +213,7 @@ public void testOutputFileParsing() throws IOException {
             assertEquals(1, openReacResult.getSvcModifications().size());
             assertEquals(1, openReacResult.getVscModifications().size());
             assertEquals(7, openReacResult.getGeneratorModifications().size());
+            assertEquals(3, openReacResult.getVoltagePlan().size());
             assertEquals(82, openReacResult.getIndicators().size());
             assertTrue(openReacResult.getReactiveSlacks().isEmpty());
         }
@@ -230,7 +231,8 @@ void testRunAsync() throws IOException {
                         subFolder + "/reactiveopf_results_rtc.csv",
                         subFolder + "/reactiveopf_results_shunts.csv",
                         subFolder + "/reactiveopf_results_static_var_compensators.csv",
-                        subFolder + "/reactiveopf_results_vsc_converter_stations.csv"));
+                        subFolder + "/reactiveopf_results_vsc_converter_stations.csv",
+                        subFolder + "/reactiveopf_results_voltages.csv"));
         // To really run open reac, use the commented line below. Be sure that open-reac/src/test/resources/com/powsybl/config/test/config.yml contains your ampl path
 //         try (ComputationManager computationManager = new LocalComputationManager()) {
         try (ComputationManager computationManager = new LocalComputationManager(new LocalComputationConfig(tmpDir),
@@ -244,23 +246,7 @@ void testRunAsync() throws IOException {
     }
 
     private void testAllModifAndLoadFlow(Network network, String subFolder, OpenReacParameters parameters) throws IOException {
-        LocalCommandExecutor localCommandExecutor = new TestLocalCommandExecutor(
-            List.of(subFolder + "/reactiveopf_results_generators.csv",
-                subFolder + "/reactiveopf_results_indic.txt",
-                subFolder + "/reactiveopf_results_rtc.csv",
-                subFolder + "/reactiveopf_results_shunts.csv",
-                subFolder + "/reactiveopf_results_static_var_compensators.csv",
-                subFolder + "/reactiveopf_results_vsc_converter_stations.csv"));
-        // To really run open reac, use the commentede line below. Be sure that open-reac/src/test/resources/com/powsybl/config/test/config.yml contains your ampl path
-//         try (ComputationManager computationManager = new LocalComputationManager()) {
-        try (ComputationManager computationManager = new LocalComputationManager(new LocalComputationConfig(tmpDir),
-            localCommandExecutor, ForkJoinPool.commonPool())) {
-            OpenReacResult openReacResult = OpenReacRunner.run(network,
-                network.getVariantManager().getWorkingVariantId(), parameters, new OpenReacConfig(true),
-                computationManager);
-            assertEquals(OpenReacStatus.OK, openReacResult.getStatus());
-            openReacResult.applyAllModifications(network);
-        }
+        runAndApplyAllModifications(network, subFolder, parameters, true);
         LoadFlowResult loadFlowResult = LoadFlow.run(network);
         assertTrue(loadFlowResult.isOk());
     }
@@ -295,23 +281,37 @@ public void testSvc() throws IOException {
     }
 
     @Test
-    public void testShuntReconnection() throws IOException {
+    void testShunt() throws IOException {
         Network network = create();
         setDefaultVoltageLimits(network); // set default voltage limits to every voltage levels of the network
+        ShuntCompensator shunt = network.getShuntCompensator("SHUNT");
+        assertFalse(shunt.getTerminal().isConnected());
+        assertEquals(393, shunt.getTargetV());
+
         OpenReacParameters parameters = new OpenReacParameters();
-        parameters.addVariableShuntCompensators(List.of("SHUNT"));
+        parameters.addVariableShuntCompensators(List.of(shunt.getId()));
         testAllModifAndLoadFlow(network, "openreac-output-shunt", parameters);
+        assertTrue(shunt.getTerminal().isConnected()); // shunt has been reconnected
+        assertEquals(420.8, shunt.getTargetV()); // targetV has been updated
     }
 
     @Test
     public void testTransformer() throws IOException {
         Network network = VoltageControlNetworkFactory.createNetworkWithT2wt();
         setDefaultVoltageLimits(network); // set default voltage limits to every voltage levels of the network
-        network.getTwoWindingsTransformer("T2wT").getRatioTapChanger().setTapPosition(2);
+        RatioTapChanger rtc = network.getTwoWindingsTransformer("T2wT").getRatioTapChanger()
+                .setTapPosition(2)
+                .setTargetDeadband(0)
+                .setRegulating(true);
+        assertEquals(2, rtc.getTapPosition());
+        assertEquals(33.0, rtc.getTargetV());
+
         OpenReacParameters parameters = new OpenReacParameters();
         parameters.addConstantQGenerators(List.of("GEN_1"));
         parameters.addVariableTwoWindingsTransformers(List.of("T2wT"));
         testAllModifAndLoadFlow(network, "openreac-output-transfo", parameters);
+        assertEquals(0, rtc.getTapPosition());
+        assertEquals(22.935, rtc.getTargetV());
     }
 
     @Test
@@ -322,6 +322,52 @@ public void testRealNetwork() throws IOException {
         testAllModifAndLoadFlow(network, "openreac-output-real-network", parameters);
     }
 
+    @Test
+    void testWarmStart() throws IOException {
+        Network network = VoltageControlNetworkFactory.createNetworkWithT2wt();
+        setDefaultVoltageLimits(network);
+        String subFolder = "openreac-output-warm-start";
+        OpenReacParameters parameters = new OpenReacParameters();
+
+        runAndApplyAllModifications(network, subFolder, parameters, false); // without warm start, no update
+        assertEquals(Double.NaN, network.getBusBreakerView().getBus("BUS_1").getV());
+        assertEquals(Double.NaN, network.getBusBreakerView().getBus("BUS_1").getAngle());
+        assertEquals(Double.NaN, network.getBusBreakerView().getBus("BUS_2").getV());
+        assertEquals(Double.NaN, network.getBusBreakerView().getBus("BUS_2").getAngle());
+        assertEquals(Double.NaN, network.getBusBreakerView().getBus("BUS_3").getV());
+        assertEquals(Double.NaN, network.getBusBreakerView().getBus("BUS_3").getAngle());
+
+        runAndApplyAllModifications(network, subFolder, parameters, true);
+        assertEquals(119.592, network.getBusBreakerView().getBus("BUS_1").getV());
+        assertEquals(0.014, network.getBusBreakerView().getBus("BUS_1").getAngle());
+        assertEquals(118.8, network.getBusBreakerView().getBus("BUS_2").getV());
+        assertEquals(0, network.getBusBreakerView().getBus("BUS_2").getAngle());
+        assertEquals(22.935, network.getBusBreakerView().getBus("BUS_3").getV());
+        assertEquals(-0.082, network.getBusBreakerView().getBus("BUS_3").getAngle());
+    }
+
+    private void runAndApplyAllModifications(Network network, String subFolder, OpenReacParameters parameters, boolean warmStart) throws IOException {
+        LocalCommandExecutor localCommandExecutor = new TestLocalCommandExecutor(
+                List.of(subFolder + "/reactiveopf_results_generators.csv",
+                        subFolder + "/reactiveopf_results_indic.txt",
+                        subFolder + "/reactiveopf_results_rtc.csv",
+                        subFolder + "/reactiveopf_results_shunts.csv",
+                        subFolder + "/reactiveopf_results_static_var_compensators.csv",
+                        subFolder + "/reactiveopf_results_vsc_converter_stations.csv",
+                        subFolder + "/reactiveopf_results_voltages.csv"));
+        // To really run open reac, use the commentede line below. Be sure that open-reac/src/test/resources/com/powsybl/config/test/config.yml contains your ampl path
+//        try (ComputationManager computationManager = new LocalComputationManager()) {
+        try (ComputationManager computationManager = new LocalComputationManager(new LocalComputationConfig(tmpDir),
+                localCommandExecutor, ForkJoinPool.commonPool())) {
+            OpenReacResult openReacResult = OpenReacRunner.run(network,
+                    network.getVariantManager().getWorkingVariantId(), parameters,
+                    new OpenReacConfig(true), computationManager);
+            assertEquals(OpenReacStatus.OK, openReacResult.getStatus());
+            openReacResult.setWarmStart(warmStart);
+            openReacResult.applyAllModifications(network);
+        }
+    }
+
     public static Network create() {
         Network network = Network.create("svc", "test");
         Substation s1 = network.newSubstation()