Mapping branches in new UCT

pom.xml

@@ -195,7 +195,6 @@
             <groupId>com.powsybl</groupId>
             <artifactId>open-rao-crac-io-commons</artifactId>
             <version>${powsybl.rao.version}</version>
-            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>com.powsybl</groupId>

src/main/java/com/rte_france/trm_algorithm/TrmAlgorithm.java

@@ -66,9 +66,9 @@ public TrmResults computeUncertainties(Network referenceNetwork, Network marketB
 
         operationalConditionAligner.align(referenceNetwork, marketBasedNetwork);
         Map<String, Double> marketBasedFlows = flowExtractor.extract(marketBasedNetwork, referenceNetworkElementIds);
-        Map<String, ZonalPtdfAndFlow> referencePdtfAndFlow = zonalSensitivityComputer.run(referenceNetwork, referenceNetworkElementIds, referenceZonalGlsks);
+        Map<String, ZonalPtdfAndFlow> referencePtdfAndFlow = zonalSensitivityComputer.run(referenceNetwork, referenceNetworkElementIds, referenceZonalGlsks);
         LOGGER.info("Computing uncertainties");
-        Map<String, UncertaintyResult> uncertaintiesMap = referencePdtfAndFlow.entrySet().stream().collect(Collectors.toMap(
+        Map<String, UncertaintyResult> uncertaintiesMap = referencePtdfAndFlow.entrySet().stream().collect(Collectors.toMap(
             Map.Entry::getKey,
             entry -> {
                 Branch<?> referenceBranch = referenceNetwork.getBranch(entry.getKey());

src/main/java/com/rte_france/trm_algorithm/id_mapping/IdMappingNotFoundException.java

@@ -0,0 +1,4 @@
+package com.rte_france.trm_algorithm.id_mapping;
+
+public class IdMappingNotFoundException extends RuntimeException {
+}

src/main/java/com/rte_france/trm_algorithm/id_mapping/IdentifiableMapp.java

@@ -0,0 +1,77 @@
+package com.rte_france.trm_algorithm.id_mapping;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class IdentifiableMapp {
+    private final Map<String, String> mappingFromMarketBasedToReference;
+    private final Map<String, String> mappingFromReferenceToMarketBased;
+    private static final Logger LOGGER = LoggerFactory.getLogger(IdentifiableMapp.class);
+
+    IdentifiableMapp(Map<String, String> mappingFromMarketBasedToReference, Map<String, String> mappingFromReferenceToMarketBased) {
+        this.mappingFromMarketBasedToReference = mappingFromMarketBasedToReference;
+        this.mappingFromReferenceToMarketBased = mappingFromReferenceToMarketBased;
+    }
+
+    public String idInReference(String s) {
+        return mappingFromMarketBasedToReference.computeIfAbsent(s, idInMarket -> {
+            throw new IdMappingNotFoundException();
+        });
+    }
+
+    public String idInMarketBased(String s) {
+        return mappingFromReferenceToMarketBased.computeIfAbsent(s, idInReference -> {
+            throw new IdMappingNotFoundException();
+        });
+    }
+
+    public static class IdentifiableMappBuilder {
+        Map<String, String> mappingFromMarketBasedToReference = new HashMap<>();
+        Map<String, String> mappingFromReferenceToMarketBased = new HashMap<>();
+        List<String> invalidatedInMarketBased = new ArrayList<>();
+        List<String> invalidatedInReference = new ArrayList<>();
+
+        IdentifiableMapp build() {
+            return new IdentifiableMapp(mappingFromMarketBasedToReference, mappingFromReferenceToMarketBased);
+        }
+
+        public void addMappingOrInvalidateDuplicates(String idMarketBased, String idReference) {
+            if (invalidatedInMarketBased.contains(idMarketBased)) {
+                LOGGER.error("Replicated branches found for: {} in reference", idMarketBased);
+                return;
+            }
+            if (invalidatedInReference.contains(idReference)) {
+                LOGGER.error("Replicated branches found for: {} in marketBased", idReference);
+                return;
+            }
+
+            if (mappingFromMarketBasedToReference.containsKey(idMarketBased) && mappingFromMarketBasedToReference.get(idMarketBased) != idReference) {
+                String previousReference = mappingFromMarketBasedToReference.get(idMarketBased);
+                mappingFromMarketBasedToReference.remove(idMarketBased);
+                mappingFromReferenceToMarketBased.remove(idReference);
+                invalidatedInMarketBased.add(idMarketBased);
+                invalidatedInReference.add(idReference);
+                invalidatedInReference.add(previousReference);
+                return;
+            }
+
+            if (mappingFromReferenceToMarketBased.containsKey(idReference) && mappingFromReferenceToMarketBased.get(idReference) != idMarketBased) {
+                String previousMarketBased = mappingFromReferenceToMarketBased.get(idReference);
+                mappingFromMarketBasedToReference.remove(idMarketBased);
+                mappingFromReferenceToMarketBased.remove(idReference);
+                invalidatedInMarketBased.add(idMarketBased);
+                invalidatedInMarketBased.add(previousMarketBased);
+                invalidatedInReference.add(idReference);
+                return;
+            }
+
+            mappingFromReferenceToMarketBased.put(idReference, idMarketBased);
+            mappingFromMarketBasedToReference.put(idMarketBased, idReference);
+        }
+    }
+}

src/main/java/com/rte_france/trm_algorithm/id_mapping/MappingResults.java

@@ -0,0 +1,16 @@
+/*
+ * 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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.rte_france.trm_algorithm.id_mapping;
+
+/**
+ * @author Sebastian Huaraca {@literal <sebastian.huaracalapa at rte-france.com>}
+ */
+
+public record MappingResults(String lineFromMarketBasedNetwork, String lineFromReferenceNetwork, boolean mappingFound) {
+
+}

src/main/java/com/rte_france/trm_algorithm/id_mapping/UcteMapping.java

@@ -0,0 +1,87 @@
+/*
+ * 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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.rte_france.trm_algorithm.id_mapping;
+
+import com.powsybl.iidm.network.*;
+import com.powsybl.openrao.data.crac.io.commons.ucte.UcteMatchingResult;
+import com.powsybl.openrao.data.crac.io.commons.ucte.UcteNetworkAnalyzer;
+import com.powsybl.openrao.data.crac.io.commons.ucte.UcteNetworkAnalyzerProperties;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import java.util.*;
+
+/**
+ * @author Sebastian Huaraca {@literal <sebastian.huaracalapa at rte-france.com>}
+ */
+
+public final class UcteMapping {
+    private static final Logger LOGGER = LoggerFactory.getLogger(UcteMapping.class);
+    private static final UcteNetworkAnalyzerProperties UCTE_NETWORK_ANALYZER_PROPERTIES = new UcteNetworkAnalyzerProperties(UcteNetworkAnalyzerProperties.BusIdMatchPolicy.REPLACE_8TH_CHARACTER_WITH_WILDCARD);
+
+    public static IdentifiableMapp mapNetworks(Network networkReference, Network networkMarketBased) {
+        IdentifiableMapp.IdentifiableMappBuilder builder = new IdentifiableMapp.IdentifiableMappBuilder();
+        UcteNetworkAnalyzer analyser = new UcteNetworkAnalyzer(networkReference, UCTE_NETWORK_ANALYZER_PROPERTIES);
+        networkMarketBased.getBranchStream().forEach(branch -> mapNetworks(analyser, builder, networkMarketBased, branch));
+        return builder.build();
+    }
+
+    static IdentifiableMapp mapNetworks(Network networkReference, Network networkMarketBased, Country... filtersCountries) {
+        IdentifiableMapp.IdentifiableMappBuilder builder = new IdentifiableMapp.IdentifiableMappBuilder();
+        UcteNetworkAnalyzer analyser = new UcteNetworkAnalyzer(networkReference, UCTE_NETWORK_ANALYZER_PROPERTIES);
+        networkMarketBased.getBranchStream()
+                .filter(branch -> isBranchConnectedToAnyGivenCountry(branch, filtersCountries))
+                .forEach(line -> mapNetworks(analyser, builder, networkMarketBased, line));
+        return builder.build();
+    }
+
+    private static boolean isBranchConnectedToAnyGivenCountry(Branch branch, Country... countries) {
+        return Arrays.stream(countries).anyMatch(country -> isBranchConnectedToCountry(branch, country));
+    }
+
+    private static boolean isBranchConnectedToCountry(Branch branch, Country country) {
+        Optional<Country> country1 = branch.getTerminal1().getVoltageLevel()
+                .getSubstation().flatMap(Substation::getCountry);
+        Optional<Country> country2 = branch.getTerminal2().getVoltageLevel()
+                .getSubstation().flatMap(Substation::getCountry);
+        return country1.isPresent() && country1.get().equals(country) ||
+                country2.isPresent() && country2.get().equals(country);
+    }
+
+    private static void mapNetworks(UcteNetworkAnalyzer analyser, IdentifiableMapp.IdentifiableMappBuilder builder, Network networkMarketBased, Branch branch) {
+        String voltageLevelSide1 = getVoltageLevelSide1(branch.getId());
+        String voltageLevelSide2 = getVoltageLevelSide2(branch.getId());
+        String orderCode = getOrderCode(branch.getId());
+        Optional<String> optionalElementName = Optional.ofNullable(networkMarketBased.getBranch(branch.getId()).getProperty("elementName"));
+        UcteMatchingResult resultOrderCode = analyser.findTopologicalElement(voltageLevelSide1, voltageLevelSide2, orderCode);
+        if (resultOrderCode.getStatus() == UcteMatchingResult.MatchStatus.SINGLE_MATCH) {
+            builder.addMappingOrInvalidateDuplicates(branch.getId(), resultOrderCode.getIidmIdentifiable().getId());
+        }
+        if (optionalElementName.isPresent()) {
+            UcteMatchingResult resultElementName = analyser.findTopologicalElement(voltageLevelSide1, voltageLevelSide2, networkMarketBased.getBranch(branch.getId()).getProperty("elementName"));
+            if (resultElementName.getStatus() == UcteMatchingResult.MatchStatus.SINGLE_MATCH) {
+                builder.addMappingOrInvalidateDuplicates(branch.getId(), resultElementName.getIidmIdentifiable().getId());
+            }
+        }
+    }
+
+    private static String getOrderCode(String id) {
+        return id.substring(18);
+    }
+
+    private static String getVoltageLevelSide2(String id) {
+        return id.substring(9, 16);
+    }
+
+    private static String getVoltageLevelSide1(String id) {
+        return id.substring(0, 7);
+    }
+
+    //Utility class
+    private UcteMapping() {
+    }
+}

src/test/java/com/rte_france/trm_algorithm/TestUtils.java

@@ -20,7 +20,6 @@
 import com.rte_france.trm_algorithm.operational_conditions_aligners.exchange_and_net_position.EmptyNetPosition;
 import com.rte_france.trm_algorithm.operational_conditions_aligners.exchange_and_net_position.ExchangeAndNetPositionInterface;
 import com.rte_france.trm_algorithm.operational_conditions_aligners.exchange_and_net_position.NetPositionInterface;
-
 import java.nio.file.Paths;
 import java.util.Collections;
 import java.util.Map;

src/test/java/com/rte_france/trm_algorithm/TrmAlgorithmTest.java

@@ -367,4 +367,16 @@ void testReferenceNetworkSubpartOfMarketBasedNetwork() {
         assertEquals(1260.669, result.get("NNL2AA1  BBE3AA1  1").getUncertainty(), EPSILON);
         assertEquals(1260.669, result.get("DDE2AA1  NNL3AA1  1").getUncertainty(), EPSILON);
     }
+
+    @Test
+    void testUcteMapping() {
+        Network referenceNetwork = TestUtils.importNetwork("TestCase12Nodes/NETWORK_TEST_IN_REFERENCE.uct");
+        Network marketBasedNetwork = TestUtils.importNetwork("TestCase12Nodes/NETWORK_TEST_IN_MARKET.uct");
+        ZonalData<SensitivityVariableSet> zonalGlsks = TrmUtils.getAutoGlsk(referenceNetwork);
+        ZonalData<Scalable> localMarketZonalScalable = TrmUtils.getAutoScalable(marketBasedNetwork);
+        XnecProvider xnecProvider = new XnecProviderInterconnection();
+        TrmAlgorithm trmAlgorithm = setUp(CracFactory.findDefault().create("crac"), localMarketZonalScalable);
+        TrmResults trmResults = trmAlgorithm.computeUncertainties(referenceNetwork, marketBasedNetwork, xnecProvider, zonalGlsks);
+        Map<String, UncertaintyResult> result = trmResults.getUncertaintiesMap();
+    }
 }

src/test/java/com/rte_france/trm_algorithm/id_mapping/UcteMappingTest.java

@@ -0,0 +1,117 @@
+/*
+ * 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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.rte_france.trm_algorithm.id_mapping;
+
+import com.powsybl.iidm.network.Country;
+import com.powsybl.iidm.network.Network;
+import com.rte_france.trm_algorithm.TestUtils;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+/**
+ * @author Sebastian Huaraca {@literal <sebastian.huaracalapa at rte-france.com>}
+ */
+
+public class UcteMappingTest {
+    @Test
+    void testMultiLines() {
+        // Given
+        Network networkReference = TestUtils.importNetwork("TestCase12Nodes/TestCase12Nodes_NewId.uct");
+        Network networkMarketBased = TestUtils.importNetwork("TestCase12Nodes/TestCase12Nodes.uct");
+        // When
+        IdentifiableMapp mappingResults = UcteMapping.mapNetworks(networkReference, networkMarketBased);
+        assertEquals("BBE1AA1  BBE2AA1  1", mappingResults.idInMarketBased("BBE1AA12 BBE2AA11 1"));
+        assertEquals("DDE1AA1  DDE2AA1  1", mappingResults.idInMarketBased("DDE1AA1  DDE2AA1  1"));
+        assertEquals("NNL2AA1  BBE3AA1  1", mappingResults.idInReference("NNL2AA1  BBE3AA1  1"));
+        assertEquals("BBE2AA11 BBE3AA1  1", mappingResults.idInReference("BBE2AA1  BBE3AA1  1"));
+        assertThrows(IdMappingNotFoundException.class, () -> mappingResults.idInReference("NON EXISTING ID"));
+    }
+
+    @Test
+    void testMultiLinesList() {
+        //Given
+        Network networkReference = TestUtils.importNetwork("TestCase12Nodes/20170322_1844_SN3_FR2.uct");
+        Network networkMarketBased = TestUtils.importNetwork("TestCase12Nodes/20170322_1844_SN3_FR2_NewId.uct");
+        //When
+        IdentifiableMapp mappingResults = UcteMapping.mapNetworks(networkReference, networkMarketBased);
+        //Then
+        List<MappingResults> expectedMappingResults = List.of(
+                new MappingResults("FFNHV111 FFNHV211 1", "FFNHV111 FFNHV211 1", true),
+                new MappingResults("FFNHV111 FFNHV211 2", "FFNHV111 FFNHV211 2", true),
+                new MappingResults("FFNHV211 FFNHV311 1", "FFNHV211 FFNHV311 1", true),
+                new MappingResults("FFNGEN71 FFNHV111 1", "FFNGEN71 FFNHV111 1", true),
+                new MappingResults("FFNHV211 FFNLOA31 L", "FFNHV211 FFNLOA31 L", true));
+        //assertEquals(expectedMappingResults, mappingResults.mappingResults());
+    }
+
+    @Test
+    void testLineSwitchPosition() {
+        //Given
+        Network networkReference = TestUtils.importNetwork("TestCase12Nodes/20170322_1844_SN3_FR2.uct");
+        Network networkMarketBased = TestUtils.importNetwork("TestCase12Nodes/20170322_1844_SN3_FR2_NewPosition.uct");
+        //When
+        IdentifiableMapp mappingResults = UcteMapping.mapNetworks(networkReference, networkMarketBased);
+        //Then
+        List<MappingResults> expectedMappingResults = List.of(
+                new MappingResults("FFNHV211 FFNHV111 1", "FFNHV111 FFNHV211 1", true),
+                new MappingResults("FFNHV111 FFNHV211 2", "FFNHV111 FFNHV211 2", true),
+                new MappingResults("FFNHV311 FFNHV211 1", "FFNHV211 FFNHV311 1", true),
+                new MappingResults("FFNGEN71 FFNHV111 1", "FFNGEN71 FFNHV111 1", true),
+                new MappingResults("FFNHV211 FFNLOA31 L", "FFNHV211 FFNLOA31 L", true));
+        //assertEquals(expectedMappingResults, mappingResults.mappingResults());
+    }
+
+    @Test
+    void testRemoveLines() {
+        //Given
+        Network networkReference = TestUtils.importNetwork("TestCase12Nodes/20170322_1844_SN3_FR2.uct");
+        Network networkMarketBased = TestUtils.importNetwork("TestCase12Nodes/20170322_1844_SN3_FR2_NewPosition.uct");
+        networkReference.getLine("FFNHV111 FFNHV211 2").remove();
+        networkMarketBased.getLine("FFNHV311 FFNHV211 1").remove();
+        //When
+        IdentifiableMapp mappingResults = UcteMapping.mapNetworks(networkReference, networkMarketBased);
+        //Then
+        assertEquals("FFNHV211 FFNHV111 1", mappingResults.idInMarketBased("FFNHV111 FFNHV211 1"));
+        assertEquals("FFNGEN71 FFNHV111 1", mappingResults.idInReference("FFNGEN71 FFNHV111 1"));
+        assertThrows(IdMappingNotFoundException.class, () -> mappingResults.idInReference("FFNHV111 FFNHV211 2"));
+    }
+
+    @Test
+    void testDuplicateValues() {
+        //Given
+        Network networkReference = TestUtils.importNetwork("TestCase12Nodes/20170322_1844_SN3_FR2_Repetitive.uct");
+        Network networkMarketBased = TestUtils.importNetwork("TestCase12Nodes/20170322_1844_SN3_FR2_NewDuplicate.uct");
+        //When
+        IdentifiableMapp mappingResults = UcteMapping.mapNetworks(networkReference, networkMarketBased);
+        //Then
+        assertEquals("FFNHV311 FFNHV211 1", mappingResults.idInMarketBased("FFNHV211 FFNHV311 1"));
+        assertEquals("FFNHV211 FFNLOA31 L", mappingResults.idInReference("FFNHV211 FFNLOA31 L"));
+        assertThrows(IdMappingNotFoundException.class, () -> mappingResults.idInMarketBased("FFNHV111 FFNHV211 1"));
+    }
+
+    @Test
+    void testRealNetwork() {
+        //Given
+        Network networkReference = Network.read("/home/huaracaseb/Bureau/Pruebas/Reference/2023_1/20230101_0330_SN7_UX0.uct");
+        Network networkMarketBased = Network.read("/home/huaracaseb/Bureau/Pruebas/MarketBased/2023_01/20230101_0330_FO7_UX1.uct");
+        //When
+        IdentifiableMapp mappingResults = UcteMapping.mapNetworks(networkReference, networkMarketBased, Country.FR, Country.CH, Country.AT, Country.SI, Country.IT);
+    }
+
+    @Test
+    void testNewMappingMap() {
+        //Given
+        Network networkReference = TestUtils.importNetwork("TestCase12Nodes/NETWORK_TEST_IN_REFERENCE.uct");
+        Network networkMarketBased = TestUtils.importNetwork("TestCase12Nodes/NETWORK_TEST_IN_MARKET.uct");
+        //When
+        IdentifiableMapp mappingResults = UcteMapping.mapNetworks(networkReference, networkMarketBased, Country.IT, Country.FR, Country.SI, Country.CH, Country.AT);
+    }
+}

src/test/resources/com/rte_france/trm_algorithm/TestCase12Nodes/20170322_1844_SN3_FR2.uct

@@ -0,0 +1,23 @@
+##C 2007.05.01
+Informations      : 20170322_1844_SN3_FR2.uct
+Date of situation : 2017/03/22 18:44
+Copyright (c) 2017, RTE
+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/.
+##N
+##ZFR
+FFNGEN71 FNGEN__ GEN- 0 2 24.000 0.00000 0.00000 -800.00 0.00000 9999.00 -9999.0 999.000 -999.00
+FFNHV111 FNHV1__ HV1- 0 0        0.00000 0.00000 0.00000 0.00000
+FFNHV211 FNHV2__ HV2- 0 0        0.00000 0.00000 0.00000 0.00000
+FFNHV311 FNHV3__ HV3- 0 3 400.00 0.00000 0.00000 0.00000 0.00000 9999.00 -9999.0 9999.00 -9999.0
+FFNLOA31 FNLOAD_ OAD- 0 0        600.000 400.000 0.00000 0.00000
+##L
+FFNHV111 FFNHV211 1 0 3.0035 32.995 385.9970   1519 NHV1    -NHV
+FFNHV111 FFNHV211 2 0 3.0035 32.995 385.9970   1519 NHV3    -NHV
+FFNHV211 FFNHV311 1 0 3.0035 32.995 385.9970   1519 NHV2    -NHV
+##T
+FFNGEN71 FFNHV111 1 0 24.00 400.0 1300. 0.0010 0.0500 0.000000 0.0000   9999 NGEN    -NHV
+FFNHV211 FFNLOA31 L 0 400.0 158.0 1000. 0.3360 15.997 -5.48435 1.2500   9999 NHV2    -NLO
+##R
+FFNHV211 FFNLOA31 L 1.000 10   0