Add contingency branch filter to network crac creator (#1660)

Author: geofjamg

data/crac/crac-io/crac-io-network/src/main/java/com/powsybl/openrao/data/crac/io/network/NetworkCracCreator.java

@@ -72,8 +72,9 @@ private static void addInstants(Crac crac, SortedMap<InstantKind, List<String>>
 
     private static void addContingencies(Crac crac, Network network, Contingencies parameters) {
         network.getBranchStream().filter(b ->
-                Utils.branchIsInCountries(b, parameters.getCountries().orElse(null))
-                    && Utils.branchIsInVRange(b, parameters.getMinV(), parameters.getMaxV()))
+                parameters.isBranchFiltered(b)
+                        && Utils.branchIsInCountries(b, parameters.getCountries().orElse(null))
+                        && Utils.branchIsInVRange(b, parameters.getMinV(), parameters.getMaxV()))
             .forEach(
                 branch -> crac.newContingency()
                     .withId("CO_" + branch.getNameOrId())

data/crac/crac-io/crac-io-network/src/main/java/com/powsybl/openrao/data/crac/io/network/parameters/Contingencies.java

@@ -7,8 +7,12 @@
 
 package com.powsybl.openrao.data.crac.io.network.parameters;
 
+import com.powsybl.iidm.network.Branch;
+
 import javax.annotation.Nullable;
+import java.util.Objects;
 import java.util.Optional;
+import java.util.function.Predicate;
 
 /**
  * Indicates what elements to simulate as contingencies (N-1).
@@ -17,6 +21,7 @@
  */
 public class Contingencies extends AbstractCountriesFilter {
     private MinAndMax<Double> minAndMaxV = new MinAndMax<>(null, null);
+    private Predicate<Branch<?>> branchFilter = branch -> true;
 
     Contingencies() {
     }
@@ -37,4 +42,12 @@ public Optional<Double> getMaxV() {
     public void setMinAndMaxV(@Nullable Double minV, @Nullable Double maxV) {
         this.minAndMaxV = new MinAndMax<>(minV, maxV);
     }
+
+    public void setBranchFilter(Predicate<Branch<?>> branchFilter) {
+        this.branchFilter = Objects.requireNonNull(branchFilter);
+    }
+
+    public boolean isBranchFiltered(Branch<?> branch) {
+        return branchFilter.test(branch);
+    }
 }

data/crac/crac-io/crac-io-network/src/test/java/com/powsybl/openrao/data/crac/io/network/NetworkCracCreatorTest.java

@@ -152,6 +152,18 @@ void testUcteCnecsFiltered() {
         assertNull(crac.getFlowCnec("BBE2AA1  FFR3AA1  1_CO_NNL1AA1  NNL2AA1  1_outage"));
     }
 
+    @Test
+    void testImportUcteContingencyBranchFiltered() {
+        parameters.getContingencies().setBranchFilter(b -> b.getId().startsWith("F"));
+        importCracFrom("TestCase12Nodes.uct");
+        assertTrue(creationContext.isCreationSuccessful());
+        assertNotNull(crac);
+        assertEquals(4, crac.getContingencies().size());
+        assertEquals(136, crac.getFlowCnecs().size());
+        assertEquals(2, crac.getPstRangeActions().size());
+        assertEquals(24, crac.getInjectionRangeActions().size());
+    }
+
     @Test
     void testUctePstsFiltered1() {
         parameters.getPstRangeActions().setCountryFilter(Set.of(Country.FR));

docs/input-data/crac/crac-generator.md

@@ -46,12 +46,14 @@ By default, all branches of the network are declared as contingencies. Only N-1
 You can set the following extra filters:
 - countries: an optional set of countries to choose the branches in. If left empty, all branches in the network are considered. If set to an empty set, no country will be considered.  
 - minAndMaxV: the nominal voltage range in which the branches will be considered as contingency elements. If min and or max is left empty, it will be ignored.
+- branchFilter: a predicate to filter branches based on their properties. If left empty, all branches are considered as contingency elements.
 
 ::::{tabs}
 :::{group-tab} JAVA creation API
 ~~~java
 networkCracCreationParameters.getContingencies().setCountries(Set.of(Country.FR, Country.BE)); // only branches in France & Belgium are considered as contingency elements
 networkCracCreationParameters.getContingencies().setMinAndMaxV(150, null); // only branches above 150kV are considered ad contingency elements
+networkCracCreationParameters.getContingencies().setBranchFilter(branch -> branch.getId().startsWith("A")); // only branches starting with A are considered as contingency elements
 ~~~
 :::
 ::::