Inter temporal extension of parameters for sensitivity computation

ra-optimisation/rao-api/src/main/java/com/powsybl/openrao/raoapi/InterTemporalRaoInput.java

@@ -7,12 +7,14 @@
 
 package com.powsybl.openrao.raoapi;
 
+import com.powsybl.openrao.commons.OpenRaoException;
 import com.powsybl.openrao.commons.TemporalData;
 import com.powsybl.openrao.data.intertemporalconstraint.PowerGradientConstraint;
 
 import java.time.OffsetDateTime;
 import java.util.HashSet;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 /**
  * @author Thomas Bouquet {@literal <thomas.bouquet at rte-france.com>}
@@ -27,6 +29,7 @@ public InterTemporalRaoInput(TemporalData<RaoInput> raoInputs, Set<OffsetDateTim
         this.raoInputs = raoInputs;
         this.timestampsToRun = timestampsToRun;
         this.powerGradientConstraints = powerGradientConstraints;
+        checkTimestampsToRun();
     }
 
     public InterTemporalRaoInput(TemporalData<RaoInput> raoInputs, Set<PowerGradientConstraint> powerGradientConstraints) {
@@ -44,4 +47,11 @@ public Set<OffsetDateTime> getTimestampsToRun() {
     public Set<PowerGradientConstraint> getPowerGradientConstraints() {
         return powerGradientConstraints;
     }
+
+    private void checkTimestampsToRun() {
+        Set<String> invalidTimestampsToRun = timestampsToRun.stream().filter(timestamp -> !raoInputs.getTimestamps().contains(timestamp)).map(OffsetDateTime::toString).collect(Collectors.toSet());
+        if (!invalidTimestampsToRun.isEmpty()) {
+            throw new OpenRaoException("Timestamp(s) '" + String.join("', '", invalidTimestampsToRun) + "' are not defined in the inputs.");
+        }
+    }
 }

ra-optimisation/rao-api/src/main/java/com/powsybl/openrao/raoapi/RaoParametersCommons.java

@@ -123,6 +123,11 @@ private RaoParametersCommons() {
     public static final String PTDF_BOUNDARIES = "ptdf-boundaries";
     public static final String PTDF_SUM_LOWER_BOUND = "ptdf-sum-lower-bound";
 
+    // -- Inter Temporal parameters
+    public static final String INTER_TEMPORAL_PARAMETERS = "inter-temporal-parameters";
+    public static final String INTER_TEMPORAL_PARAMETERS_SECTION = "rao-inter-temporal-parameters";
+    public static final String SENSITIVITY_COMPUTATIONS_IN_PARALLEL = "sensitivity-computations-in-parallel";
+
     public static PtdfApproximation stringToPtdfApproximation(String string) {
         try {
             return PtdfApproximation.valueOf(string);

ra-optimisation/rao-api/src/main/java/com/powsybl/openrao/raoapi/json/extensions/JsonInterTemporalParametersExtension.java

@@ -0,0 +1,70 @@
+/*
+ * 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.openrao.raoapi.json.extensions;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.google.auto.service.AutoService;
+import com.powsybl.openrao.commons.OpenRaoException;
+import com.powsybl.openrao.raoapi.json.JsonRaoParameters;
+import com.powsybl.openrao.raoapi.parameters.extensions.InterTemporalParametersExtension;
+
+import java.io.IOException;
+
+import static com.powsybl.openrao.raoapi.RaoParametersCommons.*;
+
+/**
+ * @author Thomas Bouquet {@literal <thomas.bouquet at rte-france.com>}
+ * @author Roxane Chen {@literal <roxane.chen at rte-france.com>}
+ */
+@AutoService(JsonRaoParameters.ExtensionSerializer.class)
+public class JsonInterTemporalParametersExtension implements JsonRaoParameters.ExtensionSerializer<InterTemporalParametersExtension> {
+
+    @Override
+    public void serialize(InterTemporalParametersExtension interTemporalParametersExtension, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
+        jsonGenerator.writeStartObject();
+        jsonGenerator.writeNumberField(SENSITIVITY_COMPUTATIONS_IN_PARALLEL, interTemporalParametersExtension.getSensitivityComputationsInParallel());
+        jsonGenerator.writeEndObject();
+    }
+
+    @Override
+    public InterTemporalParametersExtension deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
+        return deserializeAndUpdate(jsonParser, deserializationContext, new InterTemporalParametersExtension());
+    }
+
+    @Override
+    public InterTemporalParametersExtension deserializeAndUpdate(JsonParser jsonParser, DeserializationContext deserializationContext, InterTemporalParametersExtension parameters) throws IOException {
+        while (!jsonParser.nextToken().isStructEnd()) {
+            switch (jsonParser.getCurrentName()) {
+                case SENSITIVITY_COMPUTATIONS_IN_PARALLEL:
+                    jsonParser.nextToken();
+                    parameters.setSensitivityComputationsInParallel(jsonParser.getIntValue());
+                    break;
+                default:
+                    throw new OpenRaoException(String.format("Cannot deserialize inter temporal parameters: unexpected field in %s (%s)", INTER_TEMPORAL_PARAMETERS, jsonParser.getCurrentName()));
+            }
+        }
+        return parameters;
+    }
+
+    @Override
+    public String getExtensionName() {
+        return INTER_TEMPORAL_PARAMETERS;
+    }
+
+    @Override
+    public String getCategoryName() {
+        return "rao-parameters";
+    }
+
+    @Override
+    public Class<? super InterTemporalParametersExtension> getExtensionClass() {
+        return InterTemporalParametersExtension.class;
+    }
+}

ra-optimisation/rao-api/src/main/java/com/powsybl/openrao/raoapi/parameters/extensions/InterTemporalParametersConfigLoader.java

@@ -0,0 +1,47 @@
+/*
+ * 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.openrao.raoapi.parameters.extensions;
+
+import com.google.auto.service.AutoService;
+import com.powsybl.commons.config.PlatformConfig;
+import com.powsybl.openrao.raoapi.parameters.RaoParameters;
+
+import java.util.Objects;
+
+import static com.powsybl.openrao.raoapi.RaoParametersCommons.*;
+
+/**
+ * @author Thomas Bouquet {@literal <thomas.bouquet at rte-france.com>}
+ * @author Roxane Chen {@literal <roxane.chen at rte-france.com>}
+ */
+@AutoService(RaoParameters.ConfigLoader.class)
+public class InterTemporalParametersConfigLoader implements RaoParameters.ConfigLoader<InterTemporalParametersExtension> {
+
+    @Override
+    public InterTemporalParametersExtension load(PlatformConfig platformConfig) {
+        Objects.requireNonNull(platformConfig);
+        InterTemporalParametersExtension parameters = new InterTemporalParametersExtension();
+        platformConfig.getOptionalModuleConfig(INTER_TEMPORAL_PARAMETERS_SECTION)
+                .ifPresent(config -> parameters.setSensitivityComputationsInParallel(config.getIntProperty(SENSITIVITY_COMPUTATIONS_IN_PARALLEL, InterTemporalParametersExtension.DEFAULT_SENSITIVITY_COMPUTATIONS_IN_PARALLEL)));
+        return parameters;
+    }
+
+    @Override
+    public String getExtensionName() {
+        return INTER_TEMPORAL_PARAMETERS_SECTION;
+    }
+
+    @Override
+    public String getCategoryName() {
+        return "rao-parameters";
+    }
+
+    @Override
+    public Class<? super InterTemporalParametersExtension> getExtensionClass() {
+        return InterTemporalParametersExtension.class;
+    }
+}

ra-optimisation/rao-api/src/main/java/com/powsybl/openrao/raoapi/parameters/extensions/InterTemporalParametersExtension.java

@@ -0,0 +1,37 @@
+/*
+ * 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.openrao.raoapi.parameters.extensions;
+
+import com.powsybl.commons.extensions.AbstractExtension;
+import com.powsybl.openrao.raoapi.parameters.RaoParameters;
+
+import static com.powsybl.openrao.raoapi.RaoParametersCommons.INTER_TEMPORAL_PARAMETERS;
+
+/**
+ * Extension: parameters for inter-temporal RAO computations
+ *
+ * @author Thomas Bouquet {@literal <thomas.bouquet at rte-france.com>}
+ * @author Roxane Chen {@literal <roxane.chen at rte-france.com>}
+ */
+public class InterTemporalParametersExtension extends AbstractExtension<RaoParameters> {
+    static final int DEFAULT_SENSITIVITY_COMPUTATIONS_IN_PARALLEL = 1;
+    private int sensitivityComputationsInParallel = DEFAULT_SENSITIVITY_COMPUTATIONS_IN_PARALLEL;
+
+    @Override
+    public String getName() {
+        return INTER_TEMPORAL_PARAMETERS;
+    }
+
+    public int getSensitivityComputationsInParallel() {
+        return sensitivityComputationsInParallel;
+    }
+
+    public void setSensitivityComputationsInParallel(int sensitivityComputationsInParallel) {
+        this.sensitivityComputationsInParallel = sensitivityComputationsInParallel;
+    }
+}

ra-optimisation/rao-api/src/test/java/com/powsybl/openrao/raoapi/InterTemporalRaoInputTest.java

@@ -7,6 +7,7 @@
 
 package com.powsybl.openrao.raoapi;
 
+import com.powsybl.openrao.commons.OpenRaoException;
 import com.powsybl.openrao.commons.TemporalData;
 import com.powsybl.openrao.commons.TemporalDataImpl;
 import com.powsybl.openrao.data.crac.api.rangeaction.VariationDirection;
@@ -21,6 +22,7 @@
 import java.util.Set;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 /**
  * @author Thomas Bouquet {@literal <thomas.bouquet at rte-france.com>}
@@ -60,4 +62,16 @@ void testInstantiateInterTemporalRaoInputAllTimestamps() {
         assertEquals(Set.of(timestamp1, timestamp2, timestamp3), input.getTimestampsToRun());
         assertEquals(powerGradientConstraints, input.getPowerGradientConstraints());
     }
+
+    @Test
+    void testInstantiateWithMissingTimestamp() {
+        OpenRaoException exception = assertThrows(OpenRaoException.class, () -> new InterTemporalRaoInput(temporalData, Set.of(OffsetDateTime.of(2024, 12, 11, 14, 29, 0, 0, ZoneOffset.UTC)), Set.of()));
+        assertEquals("Timestamp(s) '2024-12-11T14:29Z' are not defined in the inputs.", exception.getMessage());
+    }
+
+    @Test
+    void testInstantiateWithMissingTimestamps() {
+        OpenRaoException exception = assertThrows(OpenRaoException.class, () -> new InterTemporalRaoInput(temporalData, Set.of(OffsetDateTime.of(2024, 12, 11, 14, 29, 0, 0, ZoneOffset.UTC), OffsetDateTime.of(2024, 11, 11, 14, 29, 0, 0, ZoneOffset.UTC)), Set.of()));
+        assertEquals("Timestamp(s) '2024-11-11T14:29Z', '2024-12-11T14:29Z' are not defined in the inputs.", exception.getMessage());
+    }
 }

ra-optimisation/rao-api/src/test/java/com/powsybl/openrao/raoapi/json/JsonRaoParametersTest.java

@@ -11,10 +11,7 @@
 import com.powsybl.openrao.raoapi.parameters.RangeActionsOptimizationParameters;
 import com.powsybl.openrao.raoapi.parameters.RaoParameters;
 import com.powsybl.openrao.raoapi.parameters.SecondPreventiveRaoParameters;
-import com.powsybl.openrao.raoapi.parameters.extensions.LoopFlowParametersExtension;
-import com.powsybl.openrao.raoapi.parameters.extensions.MnecParametersExtension;
-import com.powsybl.openrao.raoapi.parameters.extensions.PtdfApproximation;
-import com.powsybl.openrao.raoapi.parameters.extensions.RelativeMarginsParametersExtension;
+import com.powsybl.openrao.raoapi.parameters.extensions.*;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.DeserializationContext;
@@ -113,6 +110,9 @@ void roundTrip() throws IOException {
         parameters.getExtension(RelativeMarginsParametersExtension.class).setPtdfBoundariesFromString(stringBoundaries);
         parameters.getExtension(RelativeMarginsParametersExtension.class).setPtdfApproximation(PtdfApproximation.UPDATE_PTDF_WITH_TOPO);
         parameters.getExtension(RelativeMarginsParametersExtension.class).setPtdfSumLowerBound(0.05);
+        // -- Inter-temporal parameters
+        parameters.addExtension(InterTemporalParametersExtension.class, new InterTemporalParametersExtension());
+        parameters.getExtension(InterTemporalParametersExtension.class).setSensitivityComputationsInParallel(4);
 
         roundTripTest(parameters, JsonRaoParameters::write, JsonRaoParameters::read, "/RaoParametersSet_v2.json");
     }

ra-optimisation/rao-api/src/test/java/com/powsybl/openrao/raoapi/parameters/RaoParametersConfigTest.java

@@ -214,6 +214,16 @@ void checkRelativeMarginsConfig() {
         assertEquals(expectedBoundaries, parameters.getPtdfBoundariesAsString());
     }
 
+    @Test
+    void checkInterTemporalConfig() {
+        ModuleConfig interTemporalModuleConfig = Mockito.mock(ModuleConfig.class);
+        Mockito.when(interTemporalModuleConfig.getIntProperty(eq("sensitivity-computations-in-parallel"), anyInt())).thenReturn(4);
+        Mockito.when(mockedPlatformConfig.getOptionalModuleConfig("rao-inter-temporal-parameters")).thenReturn(Optional.of(interTemporalModuleConfig));
+        InterTemporalParametersConfigLoader configLoader = new InterTemporalParametersConfigLoader();
+        InterTemporalParametersExtension parameters = configLoader.load(mockedPlatformConfig);
+        assertEquals(4, parameters.getSensitivityComputationsInParallel());
+    }
+
     @Test
     void checkMultipleConfigs() {
         MapModuleConfig objectiveFunctionModuleConfig = platformCfg.createModuleConfig("rao-objective-function");
@@ -229,6 +239,7 @@ void checkMultipleConfigs() {
         assertTrue(Objects.isNull(parameters.getExtension(LoopFlowParametersExtension.class)));
         assertTrue(Objects.isNull(parameters.getExtension(MnecParametersExtension.class)));
         assertTrue(Objects.isNull(parameters.getExtension(RelativeMarginsParametersExtension.class)));
+        assertTrue(Objects.isNull(parameters.getExtension(InterTemporalParametersExtension.class)));
     }
 
     @Test

ra-optimisation/rao-api/src/test/java/com/powsybl/openrao/raoapi/parameters/RaoParametersYamlConfigTest.java

@@ -7,6 +7,7 @@
 package com.powsybl.openrao.raoapi.parameters;
 
 import com.powsybl.openrao.raoapi.json.JsonRaoParameters;
+import com.powsybl.openrao.raoapi.parameters.extensions.InterTemporalParametersExtension;
 import com.powsybl.openrao.raoapi.parameters.extensions.LoopFlowParametersExtension;
 import com.powsybl.openrao.raoapi.parameters.extensions.MnecParametersExtension;
 import com.powsybl.openrao.raoapi.parameters.extensions.PtdfApproximation;
@@ -92,7 +93,7 @@ void testConfigWithExtensions() throws IOException {
         assertEquals(2, loadFlowAndSensitivityParameters.getSensitivityFailureOvercost(), DOUBLE_TOLERANCE);
 
         // EXTENSIONS
-        assertEquals(3, parameters.getExtensions().size());
+        assertEquals(4, parameters.getExtensions().size());
 
         LoopFlowParametersExtension loopFlowParameters = parameters.getExtension(LoopFlowParametersExtension.class);
         assertNotNull(loopFlowParameters);
@@ -116,6 +117,10 @@ void testConfigWithExtensions() throws IOException {
         assertEquals(0.02, relativeMarginsParametersExtension.getPtdfSumLowerBound(), DOUBLE_TOLERANCE);
         assertEquals(expectedBoundaries, relativeMarginsParametersExtension.getPtdfBoundariesAsString());
 
+        InterTemporalParametersExtension interTemporalParametersExtension = parameters.getExtension(InterTemporalParametersExtension.class);
+        assertNotNull(interTemporalParametersExtension);
+        assertEquals(4, interTemporalParametersExtension.getSensitivityComputationsInParallel());
+
         // Compare to json
         roundTripTest(parameters, JsonRaoParameters::write, JsonRaoParameters::read, "/RaoParameters_config_withExtensions.json");
     }
@@ -187,6 +192,9 @@ void testConfigWithoutExtensions() throws IOException {
         RelativeMarginsParametersExtension relativeMarginsParametersExtension = parameters.getExtension(RelativeMarginsParametersExtension.class);
         assertNull(relativeMarginsParametersExtension);
 
+        InterTemporalParametersExtension interTemporalParametersExtension = parameters.getExtension(InterTemporalParametersExtension.class);
+        assertNull(interTemporalParametersExtension);
+
         // Compare to json
         roundTripTest(parameters, JsonRaoParameters::write, JsonRaoParameters::read, "/RaoParameters_config_withoutExtensions.json");
     }

ra-optimisation/rao-api/src/test/resources/RaoParametersSet_v2.json

@@ -90,6 +90,9 @@
       "ptdf-approximation" : "UPDATE_PTDF_WITH_TOPO",
       "ptdf-sum-lower-bound" : 0.05
     },
+    "inter-temporal-parameters" : {
+      "sensitivity-computations-in-parallel" : 4
+    },
     "loop-flow-parameters" : {
       "acceptable-increase" : 20.0,
       "ptdf-approximation" : "UPDATE_PTDF_WITH_TOPO_AND_PST",

ra-optimisation/rao-api/src/test/resources/RaoParameters_config_withExtensions.json

@@ -170,6 +170,9 @@
       "ptdf-approximation" : "UPDATE_PTDF_WITH_TOPO_AND_PST",
       "ptdf-sum-lower-bound" : 0.02
     },
+    "inter-temporal-parameters" : {
+      "sensitivity-computations-in-parallel" : 4
+    },
     "loop-flow-parameters" : {
       "acceptable-increase" : 11.0,
       "ptdf-approximation" : "UPDATE_PTDF_WITH_TOPO",

ra-optimisation/rao-api/src/test/resources/config_withExtensions.yml

@@ -64,4 +64,7 @@ rao-mnec-parameters:
 rao-relative-margins-parameters:
   ptdf-boundaries: [ "{FR}-{BE}", "{FR}-{DE}" ]
   ptdf-approximation: UPDATE_PTDF_WITH_TOPO_AND_PST
-  ptdf-sum-lower-bound: 0.02
+  ptdf-sum-lower-bound: 0.02
+
+rao-inter-temporal-parameters:
+  sensitivity-computations-in-parallel: 4