-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Complete results with limit violations from DynaFlow (#98)
* read constraints.xml and fill LimitViolation elements * Read constraints from constraints folder * getLimitViolation for all type of equipment/bus * Clean security analysis unit test * Remove reading powsybl-like sa output from dynawo * Force limit violations in integration tests and check results * Use ViolationLimitFilter * LimitViolationDetector not used * Add ConstraintsReader test and consecutive fixes Signed-off-by: AIA_NT\demiguelm <demiguelm@aia.es> Co-authored-by: Florian Dupuy <florian.dupuy@rte-france.com>
- Loading branch information
Showing
31 changed files
with
1,646 additions
and
9,979 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
174 changes: 174 additions & 0 deletions
174
dynaflow/src/main/java/com/powsybl/dynaflow/xml/ConstraintsReader.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| /** | ||
| * 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.dynaflow.xml; | ||
|
|
||
| import com.google.common.base.Supplier; | ||
| import com.google.common.base.Suppliers; | ||
| import com.powsybl.commons.PowsyblException; | ||
| import com.powsybl.commons.exceptions.UncheckedXmlStreamException; | ||
| import com.powsybl.commons.xml.XmlUtil; | ||
| import com.powsybl.iidm.network.*; | ||
| import com.powsybl.security.LimitViolation; | ||
| import com.powsybl.security.LimitViolationType; | ||
| import com.powsybl.security.comparator.LimitViolationComparator; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import javax.xml.stream.XMLInputFactory; | ||
| import javax.xml.stream.XMLStreamConstants; | ||
| import javax.xml.stream.XMLStreamException; | ||
| import javax.xml.stream.XMLStreamReader; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.UncheckedIOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * @author Marcos de Miguel <demiguelm at aia.es> | ||
| * @author Florian Dupuy <florian.dupuy at rte-france.com> | ||
| */ | ||
| public final class ConstraintsReader { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(ConstraintsReader.class); | ||
|
|
||
| private static final String CONSTRAINTS_ELEMENT_NAME = "constraints"; | ||
| private static final String CONSTRAINT_ELEMENT_NAME = "constraint"; | ||
| private static final String MODEL_NAME = "modelName"; | ||
| private static final String DESCRIPTION = "description"; | ||
| private static final String TYPE = "type"; | ||
| private static final String KIND = "kind"; | ||
| private static final String LIMIT = "limit"; | ||
| private static final String VALUE = "value"; | ||
| private static final String SIDE = "side"; | ||
| private static final String ACCEPTABLE_DURATION = "acceptableDuration"; | ||
|
|
||
| private static final Supplier<XMLInputFactory> XML_INPUT_FACTORY_SUPPLIER = Suppliers.memoize(XMLInputFactory::newInstance); | ||
| public static final String DYN_CALCULATED_BUS_PREFIX = "calculatedBus_"; | ||
|
|
||
| public static List<LimitViolation> read(Network network, Path xmlFile) { | ||
| try (InputStream is = Files.newInputStream(xmlFile)) { | ||
| return read(network, is); | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| } | ||
| } | ||
|
|
||
| public static List<LimitViolation> read(Network network, InputStream is) { | ||
| List<LimitViolation> limitViolations = new ArrayList<>(); | ||
|
|
||
| try { | ||
| XMLStreamReader reader = XML_INPUT_FACTORY_SUPPLIER.get().createXMLStreamReader(is); | ||
| int state = reader.next(); | ||
| while (state == XMLStreamConstants.COMMENT) { | ||
| state = reader.next(); | ||
| } | ||
|
|
||
| XmlUtil.readUntilEndElement(CONSTRAINTS_ELEMENT_NAME, reader, () -> { | ||
| if (!reader.getLocalName().equals(CONSTRAINT_ELEMENT_NAME)) { | ||
| throw new AssertionError(); | ||
| } | ||
| String name = reader.getAttributeValue(null, MODEL_NAME); | ||
| reader.getAttributeValue(null, DESCRIPTION); // description: unused | ||
| reader.getAttributeValue(null, TYPE); // type: unused | ||
| String kind = reader.getAttributeValue(null, KIND); | ||
| double limit = XmlUtil.readOptionalDoubleAttribute(reader, LIMIT); | ||
| double value = XmlUtil.readOptionalDoubleAttribute(reader, VALUE); | ||
| Integer side = XmlUtil.readOptionalIntegerAttribute(reader, SIDE); | ||
| Integer acceptableDuration = XmlUtil.readOptionalIntegerAttribute(reader, ACCEPTABLE_DURATION, Integer.MAX_VALUE); | ||
|
|
||
| getLimitViolation(network, name, kind, limit, 1f, value, side, acceptableDuration) | ||
| .ifPresent(lvRead -> addOrDismiss(lvRead, limitViolations)); | ||
| }); | ||
| return limitViolations; | ||
| } catch (XMLStreamException e) { | ||
| throw new UncheckedXmlStreamException(e); | ||
| } | ||
| } | ||
|
|
||
| private static void addOrDismiss(LimitViolation lvRead, List<LimitViolation> limitViolations) { | ||
| LimitViolationComparator comparator = new LimitViolationComparator(); | ||
| limitViolations.stream().filter(lv -> comparator.compare(lvRead, lv) == 0).findFirst() | ||
| .ifPresentOrElse( | ||
| lv -> replaceLimitViolationIfStronger(lvRead, lv, limitViolations), | ||
| () -> limitViolations.add(lvRead)); | ||
| } | ||
|
|
||
| private static void replaceLimitViolationIfStronger(LimitViolation newLimitViolation, LimitViolation similarLimitViolation, | ||
| List<LimitViolation> limitViolations) { | ||
| if (newLimitViolation.getAcceptableDuration() < similarLimitViolation.getAcceptableDuration()) { | ||
| limitViolations.remove(similarLimitViolation); | ||
| limitViolations.add(newLimitViolation); | ||
| } | ||
| } | ||
|
|
||
| private static Optional<LimitViolation> getLimitViolation(Network network, String name, String kind, double limit, | ||
| float limitReduction, double value, Integer side, Integer acceptableDuration) { | ||
|
|
||
| return getLimitViolationIdentifiable(network, name) | ||
| .map(identifiable -> new LimitViolation( | ||
| identifiable.getId(), identifiable.getOptionalName().orElse(null), | ||
| toLimitViolationType(kind), kind, acceptableDuration, | ||
| limit, limitReduction, value, toBranchSide(side))); | ||
| } | ||
|
|
||
| private static Optional<Identifiable<?>> getLimitViolationIdentifiable(Network network, String name) { | ||
| if (name.matches(DYN_CALCULATED_BUS_PREFIX + ".*_\\d*")) { | ||
| // FIXME: the voltage level information should be directly referenced | ||
| // The naming corresponds to buses which are calculated in dynawo: https://github.com/dynawo/dynawo/blob/8f1e20e43db7ec4d2e4982deac8307dfa8d0dbec/dynawo/sources/Modeler/DataInterface/PowSyblIIDM/DYNVoltageLevelInterfaceIIDM.cpp#L290 | ||
| String vlId = name.substring(DYN_CALCULATED_BUS_PREFIX.length(), name.lastIndexOf("_")); | ||
| VoltageLevel vl = network.getVoltageLevel(vlId); // Limit violation on buses are identified by their voltage level id | ||
| if (vl == null) { | ||
| LOGGER.warn("Constraint on dynawo-calculated bus {} with unknown voltage level {}", name, vlId); | ||
| } | ||
| return Optional.ofNullable(vl); | ||
| } else { | ||
| Identifiable<?> identifiable = network.getIdentifiable(name); | ||
| if (identifiable == null) { | ||
| LOGGER.warn("Unknown equipment/bus {} for limit violation in result constraints file", name); | ||
| } | ||
| if (identifiable instanceof Bus) { | ||
| identifiable = ((Bus) identifiable).getVoltageLevel(); // Limit violation on buses are identified by their voltage level id | ||
| } | ||
| return Optional.ofNullable(identifiable); | ||
| } | ||
| } | ||
|
|
||
| private static Branch.Side toBranchSide(Integer side) { | ||
| if (side == null) { | ||
| return null; | ||
| } else if (side == 1) { | ||
| return Branch.Side.ONE; | ||
| } else if (side == 2) { | ||
| return Branch.Side.TWO; | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private static LimitViolationType toLimitViolationType(String kind) { | ||
| switch (kind) { | ||
| case "UInfUmin": | ||
| return LimitViolationType.LOW_VOLTAGE; | ||
| case "USupUmax": | ||
| return LimitViolationType.HIGH_VOLTAGE; | ||
| case "OverloadOpen": | ||
| case "OverloadUp": | ||
| case "PATL": | ||
| return LimitViolationType.CURRENT; | ||
| default: | ||
| throw new PowsyblException("Unexpect violation type " + kind); | ||
| } | ||
| } | ||
|
|
||
| private ConstraintsReader() { | ||
| } | ||
| } |
45 changes: 45 additions & 0 deletions
45
dynaflow/src/test/java/com/powsybl/dynaflow/ConstraintsReaderTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /** | ||
| * 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.dynaflow; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.powsybl.commons.json.JsonUtil; | ||
| import com.powsybl.dynaflow.xml.ConstraintsReader; | ||
| import com.powsybl.iidm.network.Network; | ||
| import com.powsybl.iidm.network.test.FourSubstationsNodeBreakerFactory; | ||
| import com.powsybl.security.LimitViolation; | ||
| import com.powsybl.security.json.SecurityAnalysisJsonModule; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.StringWriter; | ||
| import java.io.Writer; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
| import static com.powsybl.commons.test.ComparisonUtils.compareTxt; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
|
||
| /** | ||
| * @author Florian Dupuy <florian.dupuy at rte-france.com> | ||
| */ | ||
| class ConstraintsReaderTest { | ||
|
|
||
| @Test | ||
| void test() throws IOException { | ||
| Network network = FourSubstationsNodeBreakerFactory.create(); | ||
| List<LimitViolation> violations = ConstraintsReader.read(network, getClass().getResourceAsStream("/constraints_sample.xml")); | ||
| assertEquals(3, violations.size()); | ||
|
|
||
| Writer stringWriter = new StringWriter(); | ||
| ObjectMapper mapper = JsonUtil.createObjectMapper().registerModule(new SecurityAnalysisJsonModule()); | ||
| mapper.writerWithDefaultPrettyPrinter().writeValue(stringWriter, violations); | ||
|
|
||
| compareTxt(Objects.requireNonNull(getClass().getResourceAsStream("/limitViolations.json")), stringWriter.toString()); | ||
| } | ||
| } |
Oops, something went wrong.