Geographical coordinates used as layout

diagram-test/pom.xml

@@ -49,5 +49,15 @@
             <groupId>com.powsybl</groupId>
             <artifactId>powsybl-iidm-extensions</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.powsybl</groupId>
+            <artifactId>powsybl-iidm-impl</artifactId>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.powsybl</groupId>
+            <artifactId>powsybl-ieee-cdf-converter</artifactId>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 </project>

diagram-test/src/main/java/com/powsybl/diagram/test/Networks.java

@@ -7,8 +7,10 @@
 package com.powsybl.diagram.test;
 
 import com.powsybl.commons.extensions.Extendable;
+import com.powsybl.ieeecdf.converter.IeeeCdfNetworkFactory;
 import com.powsybl.iidm.network.*;
 import com.powsybl.iidm.network.extensions.*;
+import com.powsybl.iidm.network.impl.extensions.SubstationPositionAdderImplProvider;
 
 import java.time.ZonedDateTime;
 import java.util.Optional;
@@ -1706,6 +1708,16 @@ public static Network createNetworkWithBatteries() {
         return network;
     }
 
+    public static Network createIeee9NetworkWithOneMissingSubstationPosition() {
+        Network network = IeeeCdfNetworkFactory.create9();
+        new SubstationPositionAdderImplProvider().newAdder(network.getSubstation("S1")).withCoordinate(new Coordinate(2d, 3d)).add();
+        new SubstationPositionAdderImplProvider().newAdder(network.getSubstation("S2")).withCoordinate(new Coordinate(4d, 5d)).add();
+        new SubstationPositionAdderImplProvider().newAdder(network.getSubstation("S3")).withCoordinate(new Coordinate(6d, 7d)).add();
+        new SubstationPositionAdderImplProvider().newAdder(network.getSubstation("S5")).withCoordinate(new Coordinate(8d, 9d)).add();
+        new SubstationPositionAdderImplProvider().newAdder(network.getSubstation("S6")).withCoordinate(new Coordinate(10d, 11d)).add();
+        return network;
+    }
+
     /**
      * <PRE>
      *         l

network-area-diagram/pom.xml

@@ -38,6 +38,10 @@
             <groupId>com.powsybl</groupId>
             <artifactId>powsybl-iidm-api</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.powsybl</groupId>
+            <artifactId>powsybl-iidm-extensions</artifactId>
+        </dependency>
        <dependency>
             <groupId>com.powsybl</groupId>
             <artifactId>powsybl-commons</artifactId>

network-area-diagram/src/main/java/com/powsybl/nad/layout/GeographicalLayoutFactory.java

@@ -0,0 +1,68 @@
+/**
+ * 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.powsybl.nad.layout;
+
+import com.powsybl.iidm.network.Network;
+import com.powsybl.iidm.network.Substation;
+import com.powsybl.iidm.network.VoltageLevel;
+import com.powsybl.iidm.network.extensions.Coordinate;
+import com.powsybl.iidm.network.extensions.SubstationPosition;
+import com.powsybl.nad.model.Point;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @author Sophie Frasnedo {@literal <sophie.frasnedo at rte-france.com>}
+ */
+public class GeographicalLayoutFactory extends FixedLayoutFactory implements LayoutFactory {
+
+    private static final int SCALING_FACTOR = 100;
+    private static final double RADIUS_FACTOR = 50;
+
+    public GeographicalLayoutFactory(Network network) {
+        this(network, SCALING_FACTOR, RADIUS_FACTOR, BasicForceLayout::new);
+    }
+
+    public GeographicalLayoutFactory(Network network, int scalingFactor, double radiusFactor, LayoutFactory layoutFactory) {
+        super(getFixedNodePosition(network, scalingFactor, radiusFactor), layoutFactory);
+    }
+
+    private static Map<String, Point> getFixedNodePosition(Network network, int scalingFactor, double radiusFactor) {
+        Map<String, Point> fixedNodePositionMap = new HashMap<>();
+        network.getSubstationStream().forEach(substation -> fillPositionMap(substation, fixedNodePositionMap, scalingFactor, radiusFactor));
+        return fixedNodePositionMap;
+    }
+
+    private static void fillPositionMap(Substation substation, Map<String, Point> fixedNodePositionMap, int scalingFactor, double radiusFactor) {
+        SubstationPosition substationPosition = substation.getExtension(SubstationPosition.class);
+        if (substationPosition != null) {
+            Coordinate coordinate = substationPosition.getCoordinate();
+            double latitude = coordinate.getLatitude();
+            double longitude = coordinate.getLongitude();
+
+            List<VoltageLevel> voltageLevelList = substation.getVoltageLevelStream().toList();
+            int voltageLevelListSize = voltageLevelList.size();
+
+            if (voltageLevelListSize == 1) {
+                String voltageLevelId = voltageLevelList.get(0).getId();
+                fixedNodePositionMap.put(voltageLevelId, new Point(longitude * scalingFactor, latitude * scalingFactor));
+            } else if (voltageLevelListSize > 1) {
+                //Deal with voltage levels within the same substation (and thus with the same coordinates)
+                double angle = 2 * Math.PI / voltageLevelListSize;
+                int i = 0;
+                for (VoltageLevel voltageLevel : voltageLevelList) {
+                    double angleVoltageLevel = angle * i;
+                    fixedNodePositionMap.put(voltageLevel.getId(), new Point(longitude * scalingFactor + radiusFactor * Math.cos(angleVoltageLevel), latitude * scalingFactor + radiusFactor * Math.sin(angleVoltageLevel)));
+                    i++;
+                }
+            }
+        }
+    }
+}

network-area-diagram/src/test/java/com/powsybl/nad/layout/LayoutWithGeographicalPositionsTest.java

@@ -0,0 +1,76 @@
+/**
+ * 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.powsybl.nad.layout;
+
+import com.powsybl.diagram.test.Networks;
+import com.powsybl.iidm.network.Network;
+import com.powsybl.iidm.network.TopologyKind;
+import com.powsybl.nad.build.iidm.NetworkGraphBuilder;
+import com.powsybl.nad.build.iidm.VoltageLevelFilter;
+import com.powsybl.nad.model.Graph;
+import com.powsybl.nad.model.Point;
+import org.junit.jupiter.api.Test;
+
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * @author Sophie Frasnedo {@literal <sophie.frasnedo at rte-france.com>}
+ */
+class LayoutWithGeographicalPositionsTest {
+
+    @Test
+    void layoutWithGeographicalPositionsTest() {
+        Network network = Networks.createIeee9NetworkWithOneMissingSubstationPosition();
+
+        Graph graph = new NetworkGraphBuilder(network, VoltageLevelFilter.NO_FILTER).buildGraph();
+        Layout forceLayout = new GeographicalLayoutFactory(network).create();
+        forceLayout.run(graph, new LayoutParameters());
+        Map<String, Point> actual = graph.getNodePositions();
+
+        assertEquals(300, actual.get("VL1").getX());
+        assertEquals(200, actual.get("VL1").getY());
+        assertEquals(500, actual.get("VL2").getX());
+        assertEquals(400, actual.get("VL2").getY());
+    }
+
+    @Test
+    void layoutWithGeographicalPositionsCustomisedParametersTest() {
+        Network network = Networks.createIeee9NetworkWithOneMissingSubstationPosition();
+
+        Graph graph = new NetworkGraphBuilder(network, VoltageLevelFilter.NO_FILTER).buildGraph();
+        Layout forceLayout = new GeographicalLayoutFactory(network, 200, 50d, BasicForceLayout::new).create();
+        forceLayout.run(graph, new LayoutParameters());
+        Map<String, Point> actual = graph.getNodePositions();
+
+        assertEquals(600, actual.get("VL1").getX());
+        assertEquals(400, actual.get("VL1").getY());
+        assertEquals(1000, actual.get("VL2").getX());
+        assertEquals(800, actual.get("VL2").getY());
+    }
+
+    @Test
+    void layoutWithGeographicalPositionsTwoVoltageLevelsInSameSubstationTest() {
+        Network network = Networks.createIeee9NetworkWithOneMissingSubstationPosition();
+        network.getSubstation("S1").newVoltageLevel().setNominalV(400d).setTopologyKind(TopologyKind.BUS_BREAKER).setId("VL1_1").add();
+        network.getSubstation("S1").newVoltageLevel().setNominalV(400d).setTopologyKind(TopologyKind.BUS_BREAKER).setId("VL1_2").add();
+        Graph graph = new NetworkGraphBuilder(network, VoltageLevelFilter.NO_FILTER).buildGraph();
+        Layout forceLayout = new GeographicalLayoutFactory(network, 100, 50d, BasicForceLayout::new).create();
+        forceLayout.run(graph, new LayoutParameters());
+        Map<String, Point> actual = graph.getNodePositions();
+
+        assertEquals(350, actual.get("VL1").getX());
+        assertEquals(200, actual.get("VL1").getY());
+        assertEquals(275, actual.get("VL1_1").getX());
+        assertEquals(243.3d, actual.get("VL1_1").getY(), 0.1);
+        assertEquals(275, actual.get("VL1_2").getX());
+        assertEquals(156.7, actual.get("VL1_2").getY(), 0.1);
+    }
+}
+