com.powsybl.shortcircuit.ShortCircuitBusResults Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-shortcircuit-api Show documentation

An API to run three-phase short-circuit analysis

There is a newer version: 6.6.0

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.shortcircuit;

/**
 * An interface describing the voltage results on a bus.
 *
 * @author Coline Piloquet {@literal }
 */
public interface ShortCircuitBusResults {

    String getVoltageLevelId();

    String getBusId();

    /**
     * Returns the magnitude of the voltage before the fault (in kV).
     */
    double getInitialVoltageMagnitude();

    /**
     * Returns the voltage drop between the voltage magnitude before and after the fault, as a percentage.
     */
    double getVoltageDropProportional();

}