com.powsybl.shortcircuit.MagnitudeFeederResult 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;

import com.powsybl.iidm.network.ThreeSides;

/**
 * Three-phase current of a feeder contributing to the short-circuit current.
 *
 * @author Coline Piloquet {@literal }
 */
public class MagnitudeFeederResult extends AbstractFeederResult {

    private final double current;

    public MagnitudeFeederResult(String connectableId, double current) {
        this(connectableId, current, null);
    }

    public MagnitudeFeederResult(String connectableId, double current, ThreeSides sides) {
        super(connectableId, sides);
        this.current = current;
    }

    /**
     * The three-phase current magnitude [in A].
     */
    public double getCurrent() {
        return current;
    }
}