BusConverter.java

/**
 * Copyright (c) 2021, 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.psse.converter;

import java.util.*;

import com.powsybl.iidm.network.Bus;
import com.powsybl.iidm.network.Network;
import com.powsybl.iidm.network.VoltageLevel;
import com.powsybl.iidm.network.util.ContainersMapping;
import com.powsybl.psse.model.pf.PsseBus;
import com.powsybl.psse.model.pf.PssePowerFlowModel;

/**
 * @author Luma Zamarre��o {@literal <zamarrenolm at aia.es>}
 * @author Jos�� Antonio Marqu��s {@literal <marquesja at aia.es>}
 */
class BusConverter extends AbstractConverter {

    BusConverter(PsseBus psseBus, ContainersMapping containerMapping, Network network, NodeBreakerImport nodeBreakerImport) {
        super(containerMapping, network);
        this.psseBus = Objects.requireNonNull(psseBus);
        this.nodeBreakerImport = Objects.requireNonNull(nodeBreakerImport);
    }

    void create(VoltageLevel voltageLevel) {
        // The bus is only created in busBranch voltage levels, when bus is a connectivity bus.
        if (nodeBreakerImport.isTopologicalBus(psseBus.getI())) {
            return;
        }

        String busId = getBusId(psseBus.getI());
        Bus bus = voltageLevel.getBusBreakerView().newBus()
                .setId(busId)
                .setName(psseBus.getName())
                .add();
        bus.setV(psseBus.getVm() * voltageLevel.getNominalV())
                .setAngle(psseBus.getVa());
    }

    static void create(PssePowerFlowModel psseModel, ContextExport contextExport) {
        List<PsseBus> buses = new ArrayList<>();
        contextExport.getFullExport().getBusISet().forEach(busI -> {
            // bus and type is always present when a psseBus is created
            Bus busViewBus = contextExport.getFullExport().getBusView(busI).orElse(null);
            int type = findBusViewBusType(busViewBus);
            String busName;
            double nominalV;
            if (busViewBus != null) {
                busName = fixBusName(busViewBus.getNameOrId());
                nominalV = busViewBus.getVoltageLevel().getNominalV();
            } else {
                VoltageLevel voltageLevel = contextExport.getFullExport().getVoltageLevel(busI).orElseThrow();
                int node = contextExport.getFullExport().getNode(busI).orElseThrow();
                busName = fixBusName(voltageLevel.getNameOrId() + "-" + node);
                nominalV = voltageLevel.getNominalV();
            }
            buses.add(createBus(busViewBus, busI, busName, nominalV, type));
        });
        psseModel.addBuses(buses);
        psseModel.replaceAllBuses(psseModel.getBuses().stream().sorted(Comparator.comparingInt(PsseBus::getI)).toList());
    }

    private static PsseBus createBus(Bus bus, int busI, String busName, double nominalV, int type) {
        PsseBus psseBus = createDefaultBus();
        psseBus.setI(busI);
        psseBus.setName(busName);
        psseBus.setBaskv(nominalV);
        psseBus.setIde(type);
        psseBus.setVm(getVm(bus));
        psseBus.setVa(getVa(bus));
        psseBus.setNvhi(getHighVm(bus));
        psseBus.setNvlo(getLowVm(bus));
        psseBus.setEvhi(getHighVm(bus));
        psseBus.setEvlo(getLowVm(bus));
        return psseBus;
    }

    static void update(PssePowerFlowModel psseModel, ContextExport contextExport) {
        psseModel.getBuses().forEach(psseBus -> {
            Optional<Bus> busViewBus = contextExport.getUpdateExport().getBusView(psseBus.getI());
            if (busViewBus.isPresent()) {
                updatePsseBus(busViewBus.get(), findBusType(busViewBus.get().getVoltageLevel(), busViewBus.get(), psseBus), psseBus);
            } else {
                updateIsolatedPsseBus(psseBus);
            }
        });
    }

    // type is preserved in the update of nodeBreaker topologies. Type is calculated internally by psse based on the status of switches
    private static int findBusType(VoltageLevel voltageLevel, Bus busView, PsseBus psseBus) {
        return exportVoltageLevelAsNodeBreaker(voltageLevel) ? psseBus.getIde() : findBusViewBusType(busView);
    }

    private static void updatePsseBus(Bus busView, int type, PsseBus psseBus) {
        if (busView == null) {
            updateIsolatedPsseBus(psseBus);
        } else {
            if (type == 4) {
                updateIsolatedPsseBus(psseBus);
            } else {
                psseBus.setVm(getVm(busView));
                psseBus.setVa(getVa(busView));
                psseBus.setIde(type);
            }
        }
    }

    private static void updateIsolatedPsseBus(PsseBus psseBus) {
        psseBus.setVm(0.0);
        psseBus.setVa(0.0);
        psseBus.setIde(4);
    }

    private final PsseBus psseBus;
    private final NodeBreakerImport nodeBreakerImport;
}