com.powsybl.shortcircuit.MagnitudeFaultResult 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.security.LimitViolation;

import java.time.Duration;
import java.util.Collections;
import java.util.List;

/**
 * Results for one fault with three-phase current magnitude.
 *
 * @author Coline Piloquet {@literal }
 */
public class MagnitudeFaultResult extends AbstractFaultResult {

    private final double current;

    private final double voltage;

    public MagnitudeFaultResult(Fault fault, double shortCircuitPower, List feederResults,
                                List limitViolations, double current, double voltage, List shortCircuitBusResults,
                                Duration timeConstant, Status status) {
        super(fault, status, shortCircuitPower, timeConstant, feederResults, limitViolations, shortCircuitBusResults);
        this.current = current;
        this.voltage = voltage;
    }

    public MagnitudeFaultResult(Fault fault, double shortCircuitPower, List feederResults,
                                List limitViolations, double current, List shortCircuitBusResults,
                                Duration timeConstant, Status status) {
        this(fault, shortCircuitPower, feederResults, limitViolations, current, Double.NaN, shortCircuitBusResults, timeConstant, status);
    }

    public MagnitudeFaultResult(Fault fault, double shortCircuitPower, List feederResults,
                                List limitViolations, double current, Duration timeConstant, Status status) {
        this(fault, shortCircuitPower, feederResults, limitViolations, current, Double.NaN, Collections.emptyList(), timeConstant, status);
    }

    public MagnitudeFaultResult(Fault fault, double shortCircuitPower, List feederResults,
                                List limitViolations, double current, Status status) {
        this(fault, shortCircuitPower, feederResults, limitViolations, current, Double.NaN, Collections.emptyList(), null, status);
    }

    public MagnitudeFaultResult(Fault fault, Status status) {
        this(fault, Double.NaN, null, null, Double.NaN, Double.NaN, Collections.emptyList(), null, status);
    }

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

    /**
     * The three-phase voltage magnitude [in kV].
     */
    public double getVoltage() {
        return voltage;
    }

}