com.powsybl.iidm.modification.PlannedDisconnection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-iidm-modification Show documentation

The network modification API and a set of classes implementing it

There is a newer version: 6.5.0-RC1

Show newest version

/*
 * 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.iidm.modification;

import com.powsybl.commons.report.ReportNode;
import com.powsybl.computation.ComputationManager;
import com.powsybl.iidm.modification.topology.NamingStrategy;
import com.powsybl.iidm.network.Network;
import com.powsybl.iidm.network.ThreeSides;
import com.powsybl.iidm.network.util.SwitchPredicates;

/**
 * This network modification is used to disconnect a network element from the bus or bus bar section to which it is
 * currently connected. This network modification should be used if the disconnection is planned. If it is not,
 * {@link UnplannedDisconnection} should be used instead.
 * It works on:
 * 
 *     Connectables
 *     HVDC lines by disconnecting their converter stations
 *     Tie lines by disconnecting their underlying dangling lines
 * 
 * The user can specify a side of the element to disconnect. If no side is specified, the network modification will
 * try to disconnect every side.
 * @author Nicolas Rol {@literal }
 */
public class PlannedDisconnection extends AbstractDisconnection {

    PlannedDisconnection(String identifiableId, boolean openFictitiousSwitches, ThreeSides side) {
        super(identifiableId, openFictitiousSwitches ?
            SwitchPredicates.IS_OPEN.negate() :
            SwitchPredicates.IS_OPEN.negate().and(SwitchPredicates.IS_NONFICTIONAL), side);
    }

    @Override
    public String getName() {
        return "PlannedDisconnection";
    }

    @Override
    public void apply(Network network, NamingStrategy namingStrategy, boolean throwException,
                      ComputationManager computationManager, ReportNode reportNode) {
        applyModification(network, true, throwException, reportNode);
    }
}