Introduce ScalingParameters for Scalable

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/AbstractCompoundScalable.java

@@ -71,11 +71,6 @@ public double minimumValue(Network n, ScalingConvention powerConvention) {
         return value;
     }
 
-    @Override
-    public double scale(Network n, double asked) {
-        return scale(n, asked, ScalingConvention.GENERATOR);
-    }
-
     @Override
     public void filterInjections(Network n, List<Injection> injections, List<String> notFoundInjections) {
         for (Scalable scalable : getScalables()) {

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/AbstractScalable.java

@@ -85,9 +85,4 @@ public double minimumValue(Network n) {
         return minimumValue(n, ScalingConvention.GENERATOR);
     }
 
-    @Override
-    public double scale(Network n, double asked) {
-        return scale(n, asked, ScalingConvention.GENERATOR);
-    }
-
 }

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/DanglingLineScalable.java

@@ -109,9 +109,9 @@ public void filterInjections(Network n, List<Injection> injections, List<String>
      * If scalingConvention is GENERATOR, the load active power decreases for positive "asked" and increases inversely
      */
     @Override
-    public double scale(Network n, double asked, Scalable.ScalingConvention scalingConvention) {
+    public double scale(Network n, double asked, ScalingContext context) {
         Objects.requireNonNull(n);
-        Objects.requireNonNull(scalingConvention);
+        Objects.requireNonNull(context);
 
         DanglingLine dl = n.getDanglingLine(id);
 
@@ -122,7 +122,7 @@ public double scale(Network n, double asked, Scalable.ScalingConvention scalingC
         }
 
         Terminal t = dl.getTerminal();
-        if (!t.isConnected()) {
+        if (!t.isConnected() && context.isReconnect()) {
             t.connect();
             LOGGER.info("Connecting {}", dl.getId());
         }
@@ -138,7 +138,7 @@ public double scale(Network n, double asked, Scalable.ScalingConvention scalingC
         double availableDown = oldP0 - minValue;
         double availableUp = maxValue - oldP0;
 
-        if (scalingConvention == LOAD) {
+        if (context.getScalingConvention() == LOAD) {
             done = asked > 0 ? Math.min(asked, availableUp) : -Math.min(-asked, availableDown);
             dl.setP0(oldP0 + done);
         } else {
@@ -161,9 +161,4 @@ public double maximumValue(Network n) {
     public double minimumValue(Network n) {
         return minimumValue(n, scalingConvention);
     }
-
-    @Override
-    public double scale(Network n, double asked) {
-        return scale(n, asked, scalingConvention);
-    }
 }

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/GeneratorScalable.java

@@ -106,9 +106,9 @@ public void filterInjections(Network n, List<Injection> injections, List<String>
      * If scalingConvention is LOAD, the generator active power decreases for positive "asked" and increases inversely
      */
     @Override
-    public double scale(Network n, double asked, ScalingConvention scalingConvention) {
+    public double scale(Network n, double asked, ScalingContext context) {
         Objects.requireNonNull(n);
-        Objects.requireNonNull(scalingConvention);
+        Objects.requireNonNull(context);
 
         Generator g = n.getGenerator(id);
         double done = 0;
@@ -118,7 +118,7 @@ public double scale(Network n, double asked, ScalingConvention scalingConvention
         }
 
         Terminal t = g.getTerminal();
-        if (!t.isConnected()) {
+        if (!t.isConnected() && context.isReconnect()) {
             new ConnectGenerator(g.getId()).apply(n);
             LOGGER.info("Connecting {}", g.getId());
         }
@@ -136,7 +136,7 @@ public double scale(Network n, double asked, ScalingConvention scalingConvention
         double availableUp = maximumTargetP - oldTargetP;
         double availableDown = oldTargetP - minimumTargetP;
 
-        if (scalingConvention == GENERATOR) {
+        if (context.getScalingConvention() == GENERATOR) {
             done = asked > 0 ? Math.min(asked, availableUp) : -Math.min(-asked, availableDown);
             g.setTargetP(oldTargetP + done);
         } else {

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/LoadScalable.java

@@ -95,9 +95,10 @@ public void filterInjections(Network n, List<Injection> injections, List<String>
         }
     }
 
-    private double scale(Network n, double asked, ScalingConvention scalingConvention, boolean constantPowerFactor) {
+    @Override
+    public double scale(Network n, double asked, ScalingContext context) {
         Objects.requireNonNull(n);
-        Objects.requireNonNull(scalingConvention);
+        Objects.requireNonNull(context);
 
         Load l = n.getLoad(id);
 
@@ -108,7 +109,7 @@ private double scale(Network n, double asked, ScalingConvention scalingConventio
         }
 
         Terminal t = l.getTerminal();
-        if (!t.isConnected()) {
+        if (!t.isConnected() && context.isReconnect()) {
             t.connect();
             LOGGER.info("Connecting {}", l.getId());
         }
@@ -125,7 +126,7 @@ private double scale(Network n, double asked, ScalingConvention scalingConventio
         double availableDown = oldP0 - minValue;
         double availableUp = maxValue - oldP0;
 
-        if (scalingConvention == LOAD) {
+        if (context.getScalingConvention() == LOAD) {
             done = asked > 0 ? Math.min(asked, availableUp) : -Math.min(-asked, availableDown);
             l.setP0(oldP0 + done);
         } else {
@@ -136,7 +137,7 @@ private double scale(Network n, double asked, ScalingConvention scalingConventio
         LOGGER.info("Change active power setpoint of {} from {} to {} ",
                 l.getId(), oldP0, l.getP0());
 
-        if (constantPowerFactor) {
+        if (context.isConstantPowerFactor()) {
             l.setQ0(l.getP0() * oldQ0 / oldP0);
             LOGGER.info("Change reactive power setpoint of {} from {} to {} ",
                     l.getId(), oldQ0, l.getQ0());
@@ -145,24 +146,4 @@ private double scale(Network n, double asked, ScalingConvention scalingConventio
         return done;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * If scalingConvention is LOAD, the load active power increases for positive "asked" and decreases inversely
-     * If scalingConvention is GENERATOR, the load active power decreases for positive "asked" and increases inversely
-     */
-    @Override
-    public double scale(Network n, double asked, ScalingConvention scalingConvention) {
-        return scale(n, asked, scalingConvention, false);
-    }
-
-    @Override
-    public double scaleWithConstantPowerFactor(Network n, double asked, ScalingConvention scalingConvention) {
-        return scale(n, asked, scalingConvention, true);
-    }
-
-    @Override
-    public double scaleWithConstantPowerFactor(Network n, double asked) {
-        return scaleWithConstantPowerFactor(n, asked, ScalingConvention.GENERATOR);
-    }
 }

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/ProportionalScalable.java

@@ -122,28 +122,24 @@ private void updateIterationPercentages() {
         });
     }
 
-    private double iterativeScale(Network n, double asked, ScalingConvention scalingConvention, boolean constantPowerFactor) {
+    private double iterativeScale(Network n, double asked, ScalingContext context) {
         double done = 0;
         while (Math.abs(asked - done) > EPSILON && notSaturated()) {
             checkIterationPercentages();
-            done += scaleIteration(n, asked - done, scalingConvention, constantPowerFactor);
+            done += scaleIteration(n, asked - done, context);
             updateIterationPercentages();
         }
         return done;
     }
 
-    private double scaleIteration(Network n, double asked, ScalingConvention scalingConvention, boolean constantPowerFactor) {
+    private double scaleIteration(Network n, double asked, ScalingContext context) {
         double done = 0;
         for (ScalablePercentage scalablePercentage : scalablePercentageList) {
             Scalable s = scalablePercentage.getScalable();
             double iterationPercentage = scalablePercentage.getIterationPercentage();
             double askedOnScalable = iterationPercentage / 100 * asked;
             double doneOnScalable = 0;
-            if (constantPowerFactor) {
-                doneOnScalable = s.scaleWithConstantPowerFactor(n, askedOnScalable, scalingConvention);
-            } else {
-                doneOnScalable = s.scale(n, askedOnScalable, scalingConvention);
-            }
+            doneOnScalable = s.scale(n, askedOnScalable, context);
             if (Math.abs(doneOnScalable - askedOnScalable) > EPSILON) {
                 scalablePercentage.setIterationPercentage(0);
             }
@@ -153,31 +149,14 @@ private double scaleIteration(Network n, double asked, ScalingConvention scaling
     }
 
     @Override
-    public double scaleWithConstantPowerFactor(Network n, double asked) {
-        return scaleWithConstantPowerFactor(n, asked, ScalingConvention.GENERATOR);
-    }
-
-    @Override
-    public double scaleWithConstantPowerFactor(Network n, double asked, ScalingConvention scalingConvention) {
-        Objects.requireNonNull(n);
-        Objects.requireNonNull(scalingConvention);
-        reinitIterationPercentage();
-        if (iterative) {
-            return iterativeScale(n, asked, scalingConvention, true);
-        } else {
-            return scaleIteration(n, asked, scalingConvention, true);
-        }
-    }
-
-    @Override
-    public double scale(Network n, double asked, ScalingConvention scalingConvention) {
+    public double scale(Network n, double asked, ScalingContext context) {
         Objects.requireNonNull(n);
-        Objects.requireNonNull(scalingConvention);
+        Objects.requireNonNull(context);
         reinitIterationPercentage();
         if (iterative) {
-            return iterativeScale(n, asked, scalingConvention, false);
+            return iterativeScale(n, asked, context);
         } else {
-            return scaleIteration(n, asked, scalingConvention, false);
+            return scaleIteration(n, asked, context);
         }
     }
 

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/Scalable.java

@@ -134,43 +134,10 @@ enum ScalingConvention {
      * @param asked value asked to adjust the scalable active power
      * @return the actual value of the scalable active power adjustment
      */
-    double scale(Network n, double asked);
+    double scale(Network n, double asked, ScalingContext context);
 
-    /**
-     * Scale the given network.
-     * The actual scaling value may be different to the one asked, if
-     * the Scalable limit is reached.
-     *
-     * @param n network
-     * @param asked value asked to adjust the scalable active power
-     * @param scalingConvention power convention used for scaling
-     * @return the actual value of the scalable active power adjustment
-     * @see ScalingConvention
-     */
-    double scale(Network n, double asked, ScalingConvention scalingConvention);
-
-    /**
-     * Scale the given network using Generator convention by default.
-     * If the object is a load, scaling is done with constant power factor.
-     * @param n network
-     * @param asked value asked to adjust the scalable active power and reactive power if load
-     * @return the actual value of the scalable active power adjustment
-     */
-    default double scaleWithConstantPowerFactor(Network n, double asked) {
-        return scale(n, asked);
-    }
-
-    /**
-     * Scale the given network.
-     * The actual scaling value may be different to the one asked, if
-     * the Scalable limit is reached. If the Scalable is a load, the power factor is kept constant.
-     * @param n network
-     * @param asked value asked to adjust the scalable active power and reactive power if load
-     * @param scalingConvention power convention used for scaling
-     * @return the actual value of the scalable active power adjustment
-     */
-    default double scaleWithConstantPowerFactor(Network n, double asked, ScalingConvention scalingConvention) {
-        return scale(n, asked, scalingConvention);
+    default double scale(Network n, double asked) {
+        return scale(n, asked, ScalingContext.getDefault());
     }
 
     /**

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/ScalableAdapter.java

@@ -58,7 +58,7 @@ public void filterInjections(Network network, List<Injection> injections, List<S
     }
 
     @Override
-    public double scale(Network n, double asked, ScalingConvention scalingConvention) {
-        return getScalable(n).scale(n, asked, scalingConvention);
+    public double scale(Network n, double asked, ScalingContext context) {
+        return getScalable(n).scale(n, asked, context);
     }
 }

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/ScalingContext.java

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) 2023, 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.iidm.modification.scalable;
+
+/**
+ * @author Coline Piloquet <coline.piloquet@rte-france.fr>
+ */
+public class ScalingContext {
+
+    private final Scalable.ScalingConvention scalingConvention;
+
+    private final boolean reconnect;
+
+    private final boolean constantPowerFactor;
+
+    public ScalingContext(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor) {
+        this.scalingConvention = scalingConvention;
+        this.reconnect = reconnect;
+        this.constantPowerFactor = constantPowerFactor;
+    }
+
+    public ScalingContext(Scalable.ScalingConvention scalingConvention) {
+        this(scalingConvention, false, false);
+    }
+
+    public ScalingContext(boolean reconnect, boolean constantPowerFactor) {
+        this(Scalable.ScalingConvention.GENERATOR, reconnect, constantPowerFactor);
+    }
+
+    /**
+     * @return the scaling convention for the scaling.
+     */
+    public Scalable.ScalingConvention getScalingConvention() {
+        return scalingConvention;
+    }
+
+    /**
+     * @return a boolean indicating if the terminal of the scalable should be reconnected if it is disconnected.
+     */
+    public boolean isReconnect() {
+        return reconnect;
+    }
+
+    /**
+     * @return a boolean indicating if the scaling should be done with constant power factor.
+     */
+    public boolean isConstantPowerFactor() {
+        return constantPowerFactor;
+    }
+
+    /**
+     * @return default scaling context: generator convention, not reconnecting terminals and not scaling at constant
+     * power factor.
+     */
+    public static ScalingContext getDefault() {
+        return new ScalingContext(Scalable.ScalingConvention.GENERATOR, false, false);
+    }
+}

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/StackScalable.java

@@ -35,14 +35,14 @@ Collection<Scalable> getScalables() {
     }
 
     @Override
-    public double scale(Network n, double asked, ScalingConvention scalingConvention) {
+    public double scale(Network n, double asked, ScalingContext context) {
         Objects.requireNonNull(n);
 
         double done = 0;
         double remaining = asked;
         for (Scalable scalable : scalables) {
             if (Math.abs(remaining) > EPSILON) {
-                double v = scalable.scale(n, remaining, scalingConvention);
+                double v = scalable.scale(n, remaining, context);
                 done += v;
                 remaining -= v;
             }

iidm/iidm-modification/src/main/java/com/powsybl/iidm/modification/scalable/UpDownScalable.java

@@ -60,7 +60,7 @@ public void filterInjections(Network network, List<Injection> injections, List<S
     }
 
     @Override
-    public double scale(Network n, double asked, ScalingConvention scalingConvention) {
-        return asked > 0 ? upScalable.scale(n, asked, scalingConvention) : downScalable.scale(n, asked, scalingConvention);
+    public double scale(Network n, double asked, ScalingContext context) {
+        return asked > 0 ? upScalable.scale(n, asked, context) : downScalable.scale(n, asked, context);
     }
 }