CGMES: remove extension for Control Areas, use IIDM Area

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/Conversion.java

@@ -232,11 +232,8 @@ public Network convert(ReportNode reportNode) {
 
         if (config.importControlAreas()) {
             context.pushReportNode(CgmesReports.convertingElementTypeReport(reportNode, CgmesNames.CONTROL_AREA));
-            network.newExtension(CgmesControlAreasAdder.class).add();
-            CgmesControlAreas cgmesControlAreas = network.getExtension(CgmesControlAreas.class);
-            cgmes.controlAreas().forEach(ca -> createControlArea(cgmesControlAreas, ca));
-            cgmes.tieFlows().forEach(tf -> addTieFlow(context, cgmesControlAreas, tf));
-            cgmesControlAreas.cleanIfEmpty();
+            cgmes.controlAreas().forEach(ca -> createControlArea(context, ca));
+            cgmes.tieFlows().forEach(tf -> addTieFlow(context, tf));
             context.popReportNode();
         }
 
@@ -401,31 +398,46 @@ private static void completeVoltagesAndAngles(Network network) {
         network.getTieLines().forEach(tieLine -> AbstractConductingEquipmentConversion.calculateVoltageAndAngleInBoundaryBus(tieLine.getDanglingLine1(), tieLine.getDanglingLine2()));
     }
 
-    private static void createControlArea(CgmesControlAreas cgmesControlAreas, PropertyBag ca) {
-        String controlAreaId = ca.getId("ControlArea");
-        cgmesControlAreas.newCgmesControlArea()
+    private static void createControlArea(Context context, PropertyBag ca) {
+        String controlAreaId = ca.getId(CgmesNames.CONTROL_AREA);
+        String type = ca.getLocal("controlAreaType");
+        Area area = context.network().newArea()
+                .setAreaType(type) // Copy the type defined by CGMES
                 .setId(controlAreaId)
                 .setName(ca.getLocal("name"))
-                .setEnergyIdentificationCodeEic(ca.getLocal("energyIdentCodeEic"))
-                .setNetInterchange(ca.asDouble("netInterchange", Double.NaN))
-                .setPTolerance(ca.asDouble("pTolerance", Double.NaN))
+                .setInterchangeTarget(ca.asDouble("netInterchange", Double.NaN))
                 .add();
+        String pTolerance = "0";
+        if (ca.containsKey(CgmesNames.P_TOLERANCE)) {
+            pTolerance = ca.get(CgmesNames.P_TOLERANCE);
+        }
+        area.setProperty(CgmesNames.P_TOLERANCE, pTolerance);
+        if (ca.containsKey(CgmesNames.ENERGY_IDENT_CODE_EIC)) {
+            area.addAlias(ca.get(CgmesNames.ENERGY_IDENT_CODE_EIC), CgmesNames.ENERGY_IDENT_CODE_EIC);
+        }
     }
 
-    private static void addTieFlow(Context context, CgmesControlAreas cgmesControlAreas, PropertyBag tf) {
-        String controlAreaId = tf.getId("ControlArea");
-        CgmesControlArea cgmesControlArea = cgmesControlAreas.getCgmesControlArea(controlAreaId);
-        if (cgmesControlArea == null) {
+    private static void addTieFlow(Context context, PropertyBag tf) {
+        String controlAreaId = tf.getId(CgmesNames.CONTROL_AREA);
+        Area area = context.network().getArea(controlAreaId);
+        if (area == null) {
             context.ignored("Tie Flow", String.format("Tie Flow %s refers to a non-existing control area", tf.getId("TieFlow")));
             return;
         }
         String terminalId = tf.getId("terminal");
         Boundary boundary = context.terminalMapping().findBoundary(terminalId, context.cgmes());
         if (boundary != null) {
-            cgmesControlArea.add(boundary);
+            area.newAreaBoundary()
+                    .setAc(true)
+                    .setBoundary(boundary)
+                    .add();
             return;
         }
-        RegulatingTerminalMapper.mapForTieFlow(terminalId, context).ifPresent(cgmesControlArea::add);
+        RegulatingTerminalMapper.mapForTieFlow(terminalId, context)
+                .ifPresent(t -> area.newAreaBoundary()
+                        .setAc(true)
+                        .setTerminal(t)
+                        .add());
     }
 
     private void convert(PropertyBags elements, String elementType, Context context) {

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/export/CgmesExportContext.java

@@ -530,21 +530,51 @@ private void addIidmMappingsEquivalentInjection(Network network) {
     }
 
     private void addIidmMappingsControlArea(Network network) {
-        CgmesControlAreas cgmesControlAreas = network.getExtension(CgmesControlAreas.class);
-        if (cgmesControlAreas == null) {
-            network.newExtension(CgmesControlAreasAdder.class).add();
-            cgmesControlAreas = network.getExtension(CgmesControlAreas.class);
-            String cgmesControlAreaId = namingStrategy.getCgmesId(refTyped(network), CONTROL_AREA);
-            cgmesControlAreas.newCgmesControlArea()
-                    .setId(cgmesControlAreaId)
-                    .setName("Network")
-                    .setEnergyIdentificationCodeEic("Network--1")
+        // If no control area exists, create one for the whole network, containing the dangling lines as boundaries,
+        // but only if the network does not contain subnetworks
+        long numControlAreas = network.getAreaStream().filter(a -> a.getAreaType().equals("ControlAreaTypeKind.Interchange")).count();
+        long numSubnetworks = network.getSubnetworks().size();
+        if (numControlAreas == 0 && numSubnetworks == 0) {
+            createDefaultControlArea(network);
+        }
+    }
+
+    private void createDefaultControlArea(Network network) {
+        String controlAreaId = namingStrategy.getCgmesId(refTyped(network), CONTROL_AREA);
+        Area area = network.newArea()
+                .setAreaType("ControlAreaTypeKind.Interchange")
+                .setId(controlAreaId)
+                .setName("Network")
+                .add();
+        if (referenceDataProvider != null && referenceDataProvider.getSourcingActor().containsKey(CgmesNames.ENERGY_IDENT_CODE_EIC)) {
+            area.addAlias(referenceDataProvider.getSourcingActor().get(CgmesNames.ENERGY_IDENT_CODE_EIC), CgmesNames.ENERGY_IDENT_CODE_EIC);
+        }
+        double currentInterchange = 0;
+        Set<String> boundaryDcNodes = getBoundaryDcNodes();
+        for (DanglingLine danglingLine : CgmesExportUtil.getBoundaryDanglingLines(network)) {
+            // Our exchange should be referred the boundary
+            area.newAreaBoundary()
+                    .setAc(isAcBoundary(danglingLine, boundaryDcNodes))
+                    .setBoundary(danglingLine.getBoundary())
                     .add();
-            CgmesControlArea cgmesControlArea = cgmesControlAreas.getCgmesControlArea(cgmesControlAreaId);
-            for (DanglingLine danglingLine : CgmesExportUtil.getBoundaryDanglingLines(network)) {
-                cgmesControlArea.add(danglingLine.getTerminal());
-            }
+            currentInterchange += danglingLine.getBoundary().getP();
         }
+        area.setInterchangeTarget(currentInterchange);
+    }
+
+    private Set<String> getBoundaryDcNodes() {
+        return referenceDataProvider.getBoundaryNodes().stream()
+                .filter(node -> node.containsKey("topologicalNodeDescription") && node.get("topologicalNodeDescription").startsWith("HVDC"))
+                .map(node -> node.getId(CgmesNames.TOPOLOGICAL_NODE))
+                .collect(Collectors.toSet());
+    }
+
+    private boolean isAcBoundary(DanglingLine danglingLine, Set<String> boundaryDcNodes) {
+        String dlBoundaryNode = danglingLine.getProperty(Conversion.CGMES_PREFIX_ALIAS_PROPERTIES + CgmesNames.TOPOLOGICAL_NODE_BOUNDARY);
+        if (dlBoundaryNode != null) {
+            return !boundaryDcNodes.contains(dlBoundaryNode);
+        }
+        return true;
     }
 
     public int getCimVersion() {

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/export/EquipmentExport.java

@@ -1365,37 +1365,47 @@ private static void writeAcdcConverterDCTerminal(String id, String conductingEqu
     }
 
     private static void writeControlAreas(String energyAreaId, Network network, String cimNamespace, String euNamespace, XMLStreamWriter writer, CgmesExportContext context) throws XMLStreamException {
-        CgmesControlAreas cgmesControlAreas = network.getExtension(CgmesControlAreas.class);
-        for (CgmesControlArea cgmesControlArea : cgmesControlAreas.getCgmesControlAreas()) {
-            writeControlArea(cgmesControlArea, energyAreaId, cimNamespace, euNamespace, writer, context, network);
+        for (Area area : network.getAreas()) {
+            if (area.getAreaType().equals("ControlAreaTypeKind.Interchange")) {
+                writeControlArea(area, energyAreaId, cimNamespace, euNamespace, writer, context, network);
+            }
         }
     }
 
-    private static void writeControlArea(CgmesControlArea cgmesControlArea, String energyAreaId, String cimNamespace, String euNamespace,
+    private static void writeControlArea(Area controlArea, String energyAreaId, String cimNamespace, String euNamespace,
                                          XMLStreamWriter writer, CgmesExportContext context, Network network) throws XMLStreamException {
         // Original control area identifiers may not respect mRID rules, so we pass it through naming strategy
         // to obtain always valid mRID identifiers
-        String controlAreaCgmesId = context.getNamingStrategy().getCgmesId(cgmesControlArea.getId());
-        ControlAreaEq.write(controlAreaCgmesId, cgmesControlArea.getName(), cgmesControlArea.getEnergyIdentificationCodeEIC(), energyAreaId, cimNamespace, euNamespace, writer, context);
-        for (Terminal terminal : cgmesControlArea.getTerminals()) {
-            Connectable<?> c = terminal.getConnectable();
-            if (c instanceof DanglingLine dl) {
-                if (network.isBoundaryElement(dl)) {
-                    String tieFlowId = context.getNamingStrategy().getCgmesId(refTyped(c), TIE_FLOW);
-                    String terminalId = context.getNamingStrategy().getCgmesIdFromAlias(dl, Conversion.CGMES_PREFIX_ALIAS_PROPERTIES + TERMINAL_BOUNDARY);
-                    TieFlowEq.write(tieFlowId, controlAreaCgmesId, terminalId, cimNamespace, writer, context);
-                } else {
-                    LOG.error("Unsupported tie flow at TieLine boundary {}", dl.getId());
-                }
-            } else {
-                LOG.warn("Ignored tie flow at {}: should be a dangling line to retrieve boundary terminal", terminal.getConnectable().getId());
-            }
+        String controlAreaCgmesId = context.getNamingStrategy().getCgmesId(controlArea.getId());
+        String energyIdentCodeEic = controlArea.getAliasFromType(CgmesNames.ENERGY_IDENT_CODE_EIC).orElse("");
+        ControlAreaEq.write(controlAreaCgmesId, controlArea.getNameOrId(), energyIdentCodeEic, energyAreaId, cimNamespace, euNamespace, writer, context);
+        for (AreaBoundary areaBoundary : controlArea.getAreaBoundaries()) {
+            TieFlow.from(areaBoundary, context, network).ifPresent(tieFlow ->
+                TieFlowEq.write(tieFlow.id(), controlAreaCgmesId, tieFlow.terminalId(), cimNamespace, writer, context)
+            );
+        }
+    }
+
+    private record TieFlow(String id, String terminalId) {
+        static Optional<TieFlow> from(AreaBoundary areaBoundary, CgmesExportContext context, Network network) {
+            return areaBoundary.getTerminal().map(terminal -> from(terminal, context))
+                    .orElse(areaBoundary.getBoundary().flatMap(boundary -> from(boundary, context, network)));
+        }
+
+        static Optional<TieFlow> from(Terminal terminal, CgmesExportContext context) {
+            return Optional.of(new TieFlow(
+                    context.getNamingStrategy().getCgmesId(refTyped(terminal.getConnectable()), TIE_FLOW),
+                    CgmesExportUtil.getTerminalId(terminal, context)));
         }
-        for (Boundary boundary : cgmesControlArea.getBoundaries()) {
+
+        static Optional<TieFlow> from(Boundary boundary, CgmesExportContext context, Network network) {
             String terminalId = getTieFlowBoundaryTerminal(boundary, context, network);
             if (terminalId != null) {
-                String tieFlowId = context.getNamingStrategy().getCgmesId(ref(terminalId), TIE_FLOW);
-                TieFlowEq.write(tieFlowId, controlAreaCgmesId, terminalId, cimNamespace, writer, context);
+                return Optional.of(new TieFlow(
+                        context.getNamingStrategy().getCgmesId(ref(terminalId), TIE_FLOW),
+                        terminalId));
+            } else {
+                return Optional.empty();
             }
         }
     }

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/export/ReferenceDataProvider.java

@@ -37,6 +37,7 @@ public class ReferenceDataProvider {
     private final Map<Double, String> baseVoltagesByNominalVoltage = new HashMap<>();
     private String equipmentBoundaryId = null;
     private String topologyBoundaryId = null;
+    private PropertyBags boundaryNodes = null;
 
     private boolean loaded = false;
 
@@ -58,6 +59,10 @@ public String getBaseVoltage(double nominalV) {
         return baseVoltagesByNominalVoltage.get(nominalV);
     }
 
+    public PropertyBags getBoundaryNodes() {
+        return boundaryNodes;
+    }
+
     public PropertyBag getSourcingActor() {
         ensureReferenceDataIsLoaded();
         return sourcingActor;
@@ -89,6 +94,7 @@ private void ensureReferenceDataIsLoaded() {
         loadBoundaryModelIds();
         loadBaseVoltages();
         loadSourcingActor();
+        loadBoundaryNodes();
         loaded = true;
     }
 
@@ -138,6 +144,13 @@ private void loadBaseVoltages() {
         )));
     }
 
+    private void loadBoundaryNodes() {
+        if (referenceData == null) {
+            return;
+        }
+        boundaryNodes = referenceData.boundaryNodes();
+    }
+
     private void loadSourcingActor() {
         if (referenceData != null) {
             if (sourcingActorName == null || sourcingActorName.isEmpty()) {

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/export/SteadyStateHypothesisExport.java

@@ -10,8 +10,6 @@
 import com.powsybl.cgmes.conversion.CgmesExport;
 import com.powsybl.cgmes.conversion.Conversion;
 import com.powsybl.cgmes.conversion.export.elements.RegulatingControlEq;
-import com.powsybl.cgmes.extensions.CgmesControlArea;
-import com.powsybl.cgmes.extensions.CgmesControlAreas;
 import com.powsybl.cgmes.extensions.CgmesTapChanger;
 import com.powsybl.cgmes.extensions.CgmesTapChangers;
 import com.powsybl.cgmes.model.CgmesMetadataModel;
@@ -843,20 +841,28 @@ private static String generatingUnitClassname(Injection<?> i) {
     }
 
     private static void writeControlAreas(Network network, String cimNamespace, XMLStreamWriter writer, CgmesExportContext context) throws XMLStreamException {
-        CgmesControlAreas areas = network.getExtension(CgmesControlAreas.class);
-        for (CgmesControlArea area : areas.getCgmesControlAreas()) {
-            writeControlArea(area, cimNamespace, writer, context);
+        for (Area area : network.getAreas()) {
+            if (area.getAreaType().equals("ControlAreaTypeKind.Interchange")) {
+                writeControlArea(area, cimNamespace, writer, context);
+            }
         }
     }
 
-    private static void writeControlArea(CgmesControlArea area, String cimNamespace, XMLStreamWriter writer, CgmesExportContext context) throws XMLStreamException {
-        String areaId = context.getNamingStrategy().getCgmesId(area.getId());
+    private static void writeControlArea(Area controlArea, String cimNamespace, XMLStreamWriter writer, CgmesExportContext context) throws XMLStreamException {
+        String areaId = context.getNamingStrategy().getCgmesId(controlArea.getId());
         CgmesExportUtil.writeStartAbout("ControlArea", areaId, cimNamespace, writer, context);
         writer.writeStartElement(cimNamespace, "ControlArea.netInterchange");
-        writer.writeCharacters(CgmesExportUtil.format(area.getNetInterchange()));
+        double netInterchange = controlArea.getInterchangeTarget().orElse(Double.NaN);
+        writer.writeCharacters(CgmesExportUtil.format(netInterchange));
         writer.writeEndElement();
+        double pTolerance;
+        if (controlArea.hasProperty("pTolerance")) {
+            pTolerance = Double.parseDouble(controlArea.getProperty("pTolerance"));
+        } else {
+            pTolerance = Math.abs(0.01 * netInterchange);
+        }
         writer.writeStartElement(cimNamespace, "ControlArea.pTolerance");
-        writer.writeCharacters(CgmesExportUtil.format(area.getPTolerance()));
+        writer.writeCharacters(CgmesExportUtil.format(pTolerance));
         writer.writeEndElement();
         writer.writeEndElement();
     }

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/export/elements/ControlAreaEq.java

@@ -22,10 +22,10 @@
 public final class ControlAreaEq {
     private static final String CONTROL_AREA_TYPE = "ControlAreaTypeKind.Interchange";
 
-    public static void write(String id, String controlAreaName, String energyIdentificationCodeEIC, String energyAreaId, String cimNamespace, String euNamespace, XMLStreamWriter writer, CgmesExportContext context) throws XMLStreamException {
+    public static void write(String id, String controlAreaName, String energyIdentCodeEIC, String energyAreaId, String cimNamespace, String euNamespace, XMLStreamWriter writer, CgmesExportContext context) throws XMLStreamException {
         CgmesExportUtil.writeStartIdName("ControlArea", id, controlAreaName, cimNamespace, writer, context);
         writer.writeStartElement(euNamespace, "IdentifiedObject.energyIdentCodeEic");
-        writer.writeCharacters(energyIdentificationCodeEIC);
+        writer.writeCharacters(energyIdentCodeEIC);
         writer.writeEndElement();
         writer.writeEmptyElement(cimNamespace, "ControlArea.type");
         writer.writeAttribute(RDF_NAMESPACE, CgmesNames.RESOURCE, cimNamespace + CONTROL_AREA_TYPE);

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/export/elements/TieFlowEq.java

@@ -9,6 +9,7 @@
 
 import com.powsybl.cgmes.conversion.export.CgmesExportContext;
 import com.powsybl.cgmes.conversion.export.CgmesExportUtil;
+import com.powsybl.commons.PowsyblException;
 
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
@@ -18,14 +19,18 @@
  */
 public final class TieFlowEq {
 
-    public static void write(String id, String controlAreaId, String terminalId, String cimNamespace, XMLStreamWriter writer, CgmesExportContext context) throws XMLStreamException {
-        CgmesExportUtil.writeStartId("TieFlow", id, false, cimNamespace, writer, context);
-        CgmesExportUtil.writeReference("TieFlow.ControlArea", controlAreaId, cimNamespace, writer, context);
-        CgmesExportUtil.writeReference("TieFlow.Terminal", terminalId, cimNamespace, writer, context);
-        writer.writeStartElement(cimNamespace, "TieFlow.positiveFlowIn");
-        writer.writeCharacters("true"); // always true
-        writer.writeEndElement();
-        writer.writeEndElement();
+    public static void write(String id, String controlAreaId, String terminalId, String cimNamespace, XMLStreamWriter writer, CgmesExportContext context) {
+        try {
+            CgmesExportUtil.writeStartId("TieFlow", id, false, cimNamespace, writer, context);
+            CgmesExportUtil.writeReference("TieFlow.ControlArea", controlAreaId, cimNamespace, writer, context);
+            CgmesExportUtil.writeReference("TieFlow.Terminal", terminalId, cimNamespace, writer, context);
+            writer.writeStartElement(cimNamespace, "TieFlow.positiveFlowIn");
+            writer.writeCharacters("true"); // always true
+            writer.writeEndElement();
+            writer.writeEndElement();
+        } catch (XMLStreamException x) {
+            throw new PowsyblException(x);
+        }
     }
 
     private TieFlowEq() {