Merge branch 'main' into 682-separate-nominal-voltage-classes

Author: flo-dup

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/ForceLayout.java

@@ -2,7 +2,7 @@
  * Java transcription of Springy v2.8.0
  *
  * Copyright (c) 2010-2018 Dennis Hotson
- * Copyright (c) 2021 RTE (https://www.rte-france.com)
+ * Copyright (c) 2021-2025 RTE (https://www.rte-france.com)
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -62,16 +62,13 @@ public class ForceLayout<V, E> {
     private static final double DEFAULT_REPULSION = 800.0;
     private static final double DEFAULT_FRICTION = 500;
     private static final double DEFAULT_MAX_SPEED = 100;
-    /** Spring repulsion is disabled by default */
-    private static final double DEFAULT_SPRING_REPULSION_FACTOR = 0.0;
 
     private int maxSteps;
     private double minEnergyThreshold;
     private double deltaTime;
     private double repulsion;
     private double friction;
     private double maxSpeed;
-    private double springRepulsionFactor;
     /** Initial location for some nodes */
     private Map<V, Point> initialPoints = Collections.emptyMap();
     /** The location of these nodes should not be modified by the layout */
@@ -95,7 +92,6 @@ public ForceLayout(Graph<V, E> graph) {
         this.repulsion = DEFAULT_REPULSION;
         this.friction = DEFAULT_FRICTION;
         this.maxSpeed = DEFAULT_MAX_SPEED;
-        this.springRepulsionFactor = DEFAULT_SPRING_REPULSION_FACTOR;
         this.graph = Objects.requireNonNull(graph);
     }
 
@@ -139,11 +135,6 @@ public ForceLayout<V, E> setMaxSpeed(double maxSpeed) {
         return this;
     }
 
-    public ForceLayout<V, E> setSpringRepulsionFactor(double springRepulsionFactor) {
-        this.springRepulsionFactor = springRepulsionFactor;
-        return this;
-    }
-
     public ForceLayout<V, E> setInitialPoints(Map<V, Point> initialPoints) {
         this.initialPoints = Objects.requireNonNull(initialPoints);
         return this;
@@ -210,9 +201,6 @@ public void execute() {
         int i;
         for (i = 0; i < maxSteps; i++) {
             applyCoulombsLawToPoints();
-            if (springRepulsionFactor != 0.0) {
-                applyCoulombsLawToSprings();
-            }
             applyHookesLaw();
             if (attractToCenterForce) {
                 attractToCenter();
@@ -255,45 +243,6 @@ private void applyCoulombsLawToPoints() {
         }
     }
 
-    private void applyCoulombsLawToSprings() {
-        for (Point point : points.values()) {
-            Vector p = point.getPosition();
-            for (Spring spring : springs) {
-                Point n1 = spring.getNode1();
-                Point n2 = spring.getNode2();
-                if (!n1.equals(point) && !n2.equals(point)) {
-                    Vector q1 = spring.getNode1().getPosition();
-                    Vector q2 = spring.getNode2().getPosition();
-                    Vector newCenter = q1.add(q2.subtract(q1).multiply(0.5));
-                    Vector force = coulombsForce(p, newCenter, repulsion * springRepulsionFactor);
-                    point.applyForce(force);
-                    n1.applyForce(force.multiply(-0.5));
-                    n2.applyForce(force.multiply(-0.5));
-                }
-            }
-        }
-        for (Spring spring : springs) {
-            Point n1 = spring.getNode1();
-            Point n2 = spring.getNode2();
-            Vector p1 = spring.getNode1().getPosition();
-            Vector p2 = spring.getNode2().getPosition();
-            Vector newCenter = p1.add(p2.subtract(p1).multiply(0.5));
-            for (Spring otherSpring : springs) {
-                if (!spring.equals(otherSpring)) {
-                    // Compute the repulsion force between centers of the springs
-                    Vector op1 = otherSpring.getNode1().getPosition();
-                    Vector op2 = otherSpring.getNode2().getPosition();
-                    Vector otherCenter = op1.add(op2.subtract(op1).multiply(0.5));
-                    Vector force = coulombsForce(newCenter, otherCenter, repulsion * springRepulsionFactor);
-
-                    // And apply it to both points of the spring
-                    n1.applyForce(force);
-                    n2.applyForce(force);
-                }
-            }
-        }
-    }
-
     private void applyHookesLaw() {
         for (Spring spring : springs) {
             Point point1 = spring.getNode1();

docs/network_area_diagrams/index.md

@@ -41,7 +41,7 @@ NetworkAreaDiagram.draw(network, Path.of("/tmp/diagram.svg"));
 
 ```java
 SvgParameters svgParameters = new SvgParameters().setFixedHeight(1000);
-LayoutParameters layoutParameters = new LayoutParameters().setSpringRepulsionFactorForceLayout(0.2);
+LayoutParameters layoutParameters = new LayoutParameters().setMaxSteps(300);
 NadParameters nadParameters = new NadParameters().setSvgParameters(svgParameters).setLayoutParameters(layoutParameters);
 NetworkAreaDiagram.draw(network, Path.of("/tmp/diagram2.svg"), nadParameters, VoltageLevelFilter.NO_FILTER);
 ```

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

@@ -1,8 +1,9 @@
 /**
- * Copyright (c) 2021, RTE (http://www.rte-france.com)
+ * Copyright (c) 2021-2025, 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;
 
@@ -44,7 +45,6 @@ protected void nodesLayout(Graph graph, LayoutParameters layoutParameters) {
         ForceLayout<Node, Edge> forceLayout = new ForceLayout<>(jgraphtGraph)
                 .setAttractToCenterForce(attractToCenterForce)
                 .setRepulsionForceFromFixedPoints(repulsionForceFromFixedPoints);
-        forceLayout.setSpringRepulsionFactor(layoutParameters.getSpringRepulsionFactorForceLayout());
         forceLayout.setMaxSteps(layoutParameters.getMaxSteps());
 
         setInitialPositions(forceLayout, graph);

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

@@ -1,8 +1,9 @@
 /**
- * Copyright (c) 2021, RTE (http://www.rte-france.com)
+ * Copyright (c) 2021-2025, 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;
 
@@ -13,7 +14,6 @@
  */
 public class LayoutParameters {
     private boolean textNodesForceLayout = false;
-    private double springRepulsionFactorForceLayout = 0.0;
     private Point textNodeFixedShift = new Point(100, -40);
     private int maxSteps = 1000;
     private double textNodeEdgeConnectionYShift = 25;
@@ -23,7 +23,6 @@ public LayoutParameters() {
 
     public LayoutParameters(LayoutParameters other) {
         this.textNodesForceLayout = other.textNodesForceLayout;
-        this.springRepulsionFactorForceLayout = other.springRepulsionFactorForceLayout;
         this.textNodeFixedShift = new Point(other.textNodeFixedShift.getX(), other.textNodeFixedShift.getY());
         this.maxSteps = other.maxSteps;
         this.textNodeEdgeConnectionYShift = other.textNodeEdgeConnectionYShift;
@@ -38,15 +37,6 @@ public LayoutParameters setTextNodesForceLayout(boolean textNodesForceLayout) {
         return this;
     }
 
-    public LayoutParameters setSpringRepulsionFactorForceLayout(double springRepulsionFactorForceLayout) {
-        this.springRepulsionFactorForceLayout = springRepulsionFactorForceLayout;
-        return this;
-    }
-
-    public double getSpringRepulsionFactorForceLayout() {
-        return springRepulsionFactorForceLayout;
-    }
-
     public Point getTextNodeFixedShift() {
         return textNodeFixedShift;
     }

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

@@ -1,8 +1,9 @@
 /**
- * Copyright (c) 2022, RTE (http://www.rte-france.com)
+ * Copyright (c) 2022-2025, 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;
 
@@ -40,13 +41,7 @@ protected LabelProvider getLabelProvider(Network network) {
     }
 
     @Test
-    void testDiamondNoSpringRepulsionFactor() {
-        assertSvgEquals("/diamond-spring-repulsion-factor-0.0.svg", LayoutNetworkFactory.createDiamond());
-    }
-
-    @Test
-    void testDiamondSmallSpringRepulsionFactor() {
-        getLayoutParameters().setSpringRepulsionFactorForceLayout(0.2);
-        assertSvgEquals("/diamond-spring-repulsion-factor-0.2.svg", LayoutNetworkFactory.createDiamond());
+    void testDiamond() {
+        assertSvgEquals("/diamond-network.svg", LayoutNetworkFactory.createDiamond());
     }
 }

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

@@ -1,8 +1,9 @@
 /**
- * Copyright (c) 2022, RTE (http://www.rte-france.com)
+ * Copyright (c) 2022-2025, 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;
 
@@ -18,15 +19,13 @@ class LayoutParametersTest {
     void test() {
         LayoutParameters layoutParameters0 = new LayoutParameters()
                 .setTextNodesForceLayout(true)
-                .setSpringRepulsionFactorForceLayout(1.0)
                 .setTextNodeFixedShift(50., 50.)
                 .setMaxSteps(20)
                 .setTextNodeEdgeConnectionYShift(30);
 
         LayoutParameters layoutParameters1 = new LayoutParameters(layoutParameters0);
 
         assertEquals(layoutParameters0.isTextNodesForceLayout(), layoutParameters1.isTextNodesForceLayout());
-        assertEquals(layoutParameters0.getSpringRepulsionFactorForceLayout(), layoutParameters1.getSpringRepulsionFactorForceLayout(), 0);
         assertEquals(layoutParameters0.getTextNodeFixedShift().getX(), layoutParameters1.getTextNodeFixedShift().getX(), 0);
         assertEquals(layoutParameters0.getTextNodeFixedShift().getY(), layoutParameters1.getTextNodeFixedShift().getY(), 0);
         assertEquals(layoutParameters0.getMaxSteps(), layoutParameters1.getMaxSteps());

network-area-diagram/src/test/resources/3wt_metadata.json

@@ -1,7 +1,6 @@
 {
   "layoutParameters" : {
     "textNodesForceLayout" : false,
-    "springRepulsionFactorForceLayout" : 0.0,
     "textNodeFixedShift" : {
       "x" : 100.0,
       "y" : -40.0

network-area-diagram/src/test/resources/IEEE_14_bus_fictitious_metadata.json

@@ -1,7 +1,6 @@
 {
   "layoutParameters" : {
     "textNodesForceLayout" : false,
-    "springRepulsionFactorForceLayout" : 0.0,
     "textNodeFixedShift" : {
       "x" : 100.0,
       "y" : -40.0

network-area-diagram/src/test/resources/IEEE_14_bus_voltage_filter2_metadata.json

@@ -1,7 +1,6 @@
 {
   "layoutParameters" : {
     "textNodesForceLayout" : false,
-    "springRepulsionFactorForceLayout" : 0.0,
     "textNodeFixedShift" : {
       "x" : 100.0,
       "y" : -40.0

network-area-diagram/src/test/resources/IEEE_14_bus_voltage_filter5_metadata.json

@@ -1,7 +1,6 @@
 {
   "layoutParameters" : {
     "textNodesForceLayout" : false,
-    "springRepulsionFactorForceLayout" : 0.0,
     "textNodeFixedShift" : {
       "x" : 100.0,
       "y" : -40.0