CGMES: remove extension for Control Areas, use IIDM Area

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

@@ -13,10 +13,7 @@
 import com.powsybl.cgmes.conversion.naming.NamingStrategy;
 import com.powsybl.cgmes.conversion.naming.NamingStrategyFactory;
 import com.powsybl.cgmes.extensions.CgmesMetadataModels;
-import com.powsybl.cgmes.model.CgmesMetadataModel;
-import com.powsybl.cgmes.model.CgmesMetadataModelImpl;
-import com.powsybl.cgmes.model.CgmesNamespace;
-import com.powsybl.cgmes.model.CgmesSubset;
+import com.powsybl.cgmes.model.*;
 import com.powsybl.commons.config.PlatformConfig;
 import com.powsybl.commons.datasource.DataSource;
 import com.powsybl.commons.exceptions.UncheckedXmlStreamException;
@@ -28,6 +25,7 @@
 import com.powsybl.commons.xml.XmlUtil;
 import com.powsybl.iidm.network.*;
 import com.powsybl.triplestore.api.PropertyBag;
+import com.powsybl.triplestore.api.PropertyBags;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -42,6 +40,8 @@
 import java.util.stream.Collectors;
 
 import static com.powsybl.cgmes.conversion.CgmesReports.inconsistentProfilesTPRequiredReport;
+import static com.powsybl.cgmes.conversion.naming.CgmesObjectReference.Part.CONTROL_AREA;
+import static com.powsybl.cgmes.conversion.naming.CgmesObjectReference.refTyped;
 
 /**
  * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
@@ -78,6 +78,49 @@ public List<Parameter> getParameters() {
     public void export(Network network, Properties parameters, DataSource dataSource, ReportNode reportNode) {
         Objects.requireNonNull(network);
 
+        CgmesExportContext context = createContext(network, parameters, reportNode);
+
+        // Export the network
+        if (Parameter.readBoolean(getFormat(), parameters, CGM_EXPORT_PARAMETER, defaultValueConfig)) {
+            exportCGM(network, dataSource, context);
+        } else {
+            exportIGM(network, dataSource, context);
+        }
+    }
+
+    public void createDefaultControlAreaInterchange(Network network) {
+        createDefaultControlAreaInterchange(network, null);
+    }
+
+    public void createDefaultControlAreaInterchange(Network network, Properties parameters) {
+        Objects.requireNonNull(network);
+
+        CgmesExportContext context = createContext(network, parameters, ReportNode.NO_OP);
+
+        String controlAreaId = context.getNamingStrategy().getCgmesId(refTyped(network), CONTROL_AREA);
+        Area area = network.newArea()
+                .setAreaType("ControlAreaTypeKind.Interchange")
+                .setId(controlAreaId)
+                .setName("Network")
+                .add();
+        ReferenceDataProvider referenceDataProvider = context.getReferenceDataProvider();
+        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(referenceDataProvider);
+        for (DanglingLine danglingLine : CgmesExportUtil.getBoundaryDanglingLines(network)) {
+            // Our exchange should be referred the boundary
+            area.newAreaBoundary()
+                    .setAc(isAcBoundary(danglingLine, boundaryDcNodes))
+                    .setBoundary(danglingLine.getBoundary())
+                    .add();
+            currentInterchange += danglingLine.getBoundary().getP();
+        }
+        area.setInterchangeTarget(currentInterchange);
+    }
+
+    private CgmesExportContext createContext(Network network, Properties parameters, ReportNode reportNode) {
         // Determine reference data (boundaries, base voltages and other sourcing references) for the export
         String sourcingActorName = Parameter.readString(getFormat(), parameters, SOURCING_ACTOR_PARAMETER, defaultValueConfig);
         String countryName = getCountry(network);
@@ -90,12 +133,30 @@ public void export(Network network, Properties parameters, DataSource dataSource
         CgmesExportContext context = new CgmesExportContext(network, referenceDataProvider, namingStrategy);
         addParametersToContext(context, parameters, reportNode, referenceDataProvider);
 
-        // Export the network
-        if (Parameter.readBoolean(getFormat(), parameters, CGM_EXPORT_PARAMETER, defaultValueConfig)) {
-            exportCGM(network, dataSource, context);
+        return context;
+    }
+
+    private Set<String> getBoundaryDcNodes(ReferenceDataProvider referenceDataProvider) {
+        if (referenceDataProvider == null) {
+            return Collections.emptySet();
+        }
+        PropertyBags boundaryNodes = referenceDataProvider.getBoundaryNodes();
+        if (boundaryNodes == null) {
+            return Collections.emptySet();
         } else {
-            exportIGM(network, dataSource, context);
+            return boundaryNodes.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;
     }
 
     /**

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

@@ -231,13 +231,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();
-            context.popReportNode();
+            convert(cgmes.controlAreas(), CgmesNames.CONTROL_AREA, context);
+            convert(cgmes.tieFlows(), CgmesNames.TIE_FLOW, context);
         }
 
         context.pushReportNode(CgmesReports.convertingElementTypeReport(reportNode, CgmesNames.REGULATING_CONTROL));
@@ -401,33 +396,6 @@ 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()
-                .setId(controlAreaId)
-                .setName(ca.getLocal("name"))
-                .setEnergyIdentificationCodeEic(ca.getLocal("energyIdentCodeEic"))
-                .setNetInterchange(ca.asDouble("netInterchange", Double.NaN))
-                .setPTolerance(ca.asDouble("pTolerance", Double.NaN))
-                .add();
-    }
-
-    private static void addTieFlow(Context context, CgmesControlAreas cgmesControlAreas, PropertyBag tf) {
-        String controlAreaId = tf.getId("ControlArea");
-        CgmesControlArea cgmesControlArea = cgmesControlAreas.getCgmesControlArea(controlAreaId);
-        if (cgmesControlArea == 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);
-            return;
-        }
-        RegulatingTerminalMapper.mapForTieFlow(terminalId, context).ifPresent(cgmesControlArea::add);
-    }
-
     private void convert(PropertyBags elements, String elementType, Context context) {
         context.pushReportNode(CgmesReports.convertingElementTypeReport(context.getReportNode(), elementType));
         for (PropertyBag element : elements) {
@@ -452,6 +420,8 @@ private void convert(PropertyBags elements, String elementType, Context context)
                 case CgmesNames.SERIES_COMPENSATOR -> new SeriesCompensatorConversion(element, context);
                 case CgmesNames.OPERATIONAL_LIMIT -> new OperationalLimitConversion(element, context);
                 case CgmesNames.SV_INJECTION -> new SvInjectionConversion(element, context);
+                case CgmesNames.CONTROL_AREA -> new ControlAreaConversion(element, context);
+                case CgmesNames.TIE_FLOW -> new TieFlowConversion(element, context);
                 default -> throw new IllegalArgumentException("Invalid elementType.");
             };
             if (c.insideBoundary()) {

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

@@ -28,7 +28,7 @@
  * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
  * @author José Antonio Marqués {@literal <marquesja at aia.es>}
  */
-final class RegulatingTerminalMapper {
+public final class RegulatingTerminalMapper {
 
     private RegulatingTerminalMapper() {
         // Empty constructor for utility class
@@ -105,7 +105,7 @@ private static <T> Stream<? extends Terminal> allTerminals(VoltageLevel vl, Set<
                 .filter(terminal -> vertices.contains(terminalToVertex.apply(terminal)));
     }
 
-    static class TerminalAndSign {
+    public static class TerminalAndSign {
         private final Terminal terminal;
         private final int sign;
 

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/elements/ControlAreaConversion.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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.cgmes.conversion.elements;
+
+import com.powsybl.cgmes.conversion.Context;
+import com.powsybl.cgmes.model.CgmesNames;
+import com.powsybl.iidm.network.Area;
+import com.powsybl.triplestore.api.PropertyBag;
+
+/**
+ * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
+ */
+public class ControlAreaConversion extends AbstractIdentifiedObjectConversion {
+
+    public ControlAreaConversion(PropertyBag area, Context context) {
+        super(CgmesNames.CONTROL_AREA, area, context);
+    }
+
+    @Override
+    public boolean valid() {
+        return true;
+    }
+
+    @Override
+    public void convert() {
+        String controlAreaId = p.getId(CgmesNames.CONTROL_AREA);
+        String type = p.getLocal("controlAreaType");
+        Area area = context.network().newArea()
+                .setAreaType(type) // Copy the type defined by CGMES
+                .setId(controlAreaId)
+                .setName(p.getLocal("name"))
+                .setInterchangeTarget(p.asDouble("netInterchange", Double.NaN))
+                .add();
+        if (p.containsKey(CgmesNames.P_TOLERANCE)) {
+            String pTolerance = p.get(CgmesNames.P_TOLERANCE);
+            area.setProperty(CgmesNames.P_TOLERANCE, pTolerance);
+        }
+        if (p.containsKey(CgmesNames.ENERGY_IDENT_CODE_EIC)) {
+            area.addAlias(p.get(CgmesNames.ENERGY_IDENT_CODE_EIC), CgmesNames.ENERGY_IDENT_CODE_EIC);
+        }
+    }
+}

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/elements/TieFlowConversion.java

@@ -0,0 +1,63 @@
+/**
+ 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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.cgmes.conversion.elements;
+
+import com.powsybl.cgmes.conversion.Context;
+import com.powsybl.cgmes.conversion.RegulatingTerminalMapper;
+import com.powsybl.cgmes.model.CgmesNames;
+import com.powsybl.cgmes.model.CgmesTerminal;
+import com.powsybl.iidm.network.Area;
+import com.powsybl.iidm.network.Boundary;
+import com.powsybl.triplestore.api.PropertyBag;
+
+/**
+ * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
+ */
+public class TieFlowConversion extends AbstractIdentifiedObjectConversion {
+
+    public TieFlowConversion(PropertyBag tieFlow, Context context) {
+        super(CgmesNames.TIE_FLOW, tieFlow, context);
+    }
+
+    @Override
+    public boolean valid() {
+        return true;
+    }
+
+    @Override
+    public void convert() {
+        String controlAreaId = p.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", p.getId("TieFlow")));
+            return;
+        }
+        String terminalId = p.getId("terminal");
+        boolean isAc = isConsideredAcTieFlow(terminalId);
+        Boundary boundary = context.terminalMapping().findBoundary(terminalId, context.cgmes());
+        if (boundary != null) {
+            area.newAreaBoundary()
+                    .setAc(isAc)
+                    .setBoundary(boundary)
+                    .add();
+            return;
+        }
+        RegulatingTerminalMapper.mapForTieFlow(terminalId, context)
+                .ifPresent(t -> area.newAreaBoundary()
+                        .setAc(isAc)
+                        .setTerminal(t)
+                        .add());
+    }
+
+    private boolean isConsideredAcTieFlow(String terminalId) {
+        CgmesTerminal cgmesTerminal = context.cgmes().terminal(terminalId);
+        String node = cgmesTerminal.topologicalNode() == null ? cgmesTerminal.connectivityNode() : cgmesTerminal.topologicalNode();
+        boolean isDc = context.boundary().isHvdc(node);
+        return !isDc;
+    }
+}

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

@@ -154,6 +154,10 @@ public CgmesExportContext(Network network, ReferenceDataProvider referenceDataPr
         }
     }
 
+    public ReferenceDataProvider getReferenceDataProvider() {
+        return referenceDataProvider;
+    }
+
     private CgmesTopologyKind networkTopologyKind(Network network) {
         for (VoltageLevel vl : network.getVoltageLevels()) {
             if (vl.getTopologyKind().equals(TopologyKind.NODE_BREAKER)) {
@@ -180,7 +184,6 @@ public void addIidmMappings(Network network) {
         addIidmMappingsStaticVarCompensators(network);
         addIidmMappingsEndsAndTapChangers(network);
         addIidmMappingsEquivalentInjection(network);
-        addIidmMappingsControlArea(network);
     }
 
     private void addIidmMappingsSubstations(Network network) {
@@ -531,24 +534,6 @@ 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")
-                    .add();
-            CgmesControlArea cgmesControlArea = cgmesControlAreas.getCgmesControlArea(cgmesControlAreaId);
-            for (DanglingLine danglingLine : CgmesExportUtil.getBoundaryDanglingLines(network)) {
-                cgmesControlArea.add(danglingLine.getTerminal());
-            }
-        }
-    }
-
     public int getCimVersion() {
         return cim.getVersion();
     }