Package com.powsybl.shortcircuit

Class ShortCircuitParameters

java.lang.Object

com.powsybl.commons.extensions.AbstractExtendable<ShortCircuitParameters>

com.powsybl.shortcircuit.ShortCircuitParameters

All Implemented Interfaces:

Extendable<ShortCircuitParameters>

public class ShortCircuitParameters
extends AbstractExtendable<ShortCircuitParameters>

Generic parameters for short circuit-computations. May contain extensions for implementation-specific parameters.

Author:

Boubakeur Brahimi

Field Summary

Fields

Modifier and Type	Field	Description
static String	VERSION

Constructor Summary

Constructors

Constructor	Description
ShortCircuitParameters()

Method Summary

Modifier and Type	Method	Description
double	getMinVoltageDropProportionalThreshold()	The maximum voltage drop threshold in %, to filter the results.
StudyType	getStudyType()	The type of study: transient, subtransient or steady state.
boolean	isWithFeederResult()	Whether the results should include the currents on each feeder of the fault point.
boolean	isWithFortescueResult()	Whether faultResults, feederResults and shortCircuitBusResults should be detailed for each phase as FortescueValues or if only the three-phase magnitude for currents and voltages should be given.
boolean	isWithLimitViolations()
boolean	isWithVoltageMap()	Deprecated. Use isWithVoltageResult() instead.
boolean	isWithVoltageResult()	Whether the results should include the voltages and voltage drops on every bus of the network.
static ShortCircuitParameters	load()	Load parameters from platform default config.
static ShortCircuitParameters	load(PlatformConfig platformConfig)
ShortCircuitParameters	setMinVoltageDropProportionalThreshold(double minVoltageDropProportionalThreshold)
ShortCircuitParameters	setStudyType(StudyType studyType)
ShortCircuitParameters	setWithFeederResult(boolean withFeederResult)
ShortCircuitParameters	setWithFortescueResult(boolean withFortescueResult)
ShortCircuitParameters	setWithLimitViolations(boolean withLimitViolations)
ShortCircuitParameters	setWithVoltageMap(boolean withVoltageMap)	Deprecated. Use setWithVoltageResult(boolean) instead.
ShortCircuitParameters	setWithVoltageResult(boolean withVoltageResult)

Methods inherited from class com.powsybl.commons.extensions.AbstractExtendable

addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.powsybl.commons.extensions.Extendable

newExtension

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

ShortCircuitParameters

public ShortCircuitParameters()

Method Detail

load

public static ShortCircuitParameters load()

Load parameters from platform default config.

load

public static ShortCircuitParameters load(PlatformConfig platformConfig)

isWithLimitViolations

public boolean isWithLimitViolations()

setWithLimitViolations

public ShortCircuitParameters setWithLimitViolations(boolean withLimitViolations)

isWithVoltageMap

@Deprecated
public boolean isWithVoltageMap()

Deprecated.

Use isWithVoltageResult() instead. Used for backward compatibility.

setWithVoltageMap

@Deprecated
public ShortCircuitParameters setWithVoltageMap(boolean withVoltageMap)

Deprecated.

Use setWithVoltageResult(boolean) instead. Used for backward compatibility.

isWithFortescueResult

public boolean isWithFortescueResult()

Whether faultResults, feederResults and shortCircuitBusResults should be detailed for each phase as FortescueValues or if only the three-phase magnitude for currents and voltages should be given.

setWithFortescueResult

public ShortCircuitParameters setWithFortescueResult(boolean withFortescueResult)

getStudyType

public StudyType getStudyType()

The type of study: transient, subtransient or steady state.

setStudyType

public ShortCircuitParameters setStudyType(StudyType studyType)

isWithFeederResult

public boolean isWithFeederResult()

Whether the results should include the currents on each feeder of the fault point.

setWithFeederResult

public ShortCircuitParameters setWithFeederResult(boolean withFeederResult)

isWithVoltageResult

public boolean isWithVoltageResult()

Whether the results should include the voltages and voltage drops on every bus of the network.

setWithVoltageResult

public ShortCircuitParameters setWithVoltageResult(boolean withVoltageResult)

getMinVoltageDropProportionalThreshold

public double getMinVoltageDropProportionalThreshold()

The maximum voltage drop threshold in %, to filter the results.

setMinVoltageDropProportionalThreshold

public ShortCircuitParameters setMinVoltageDropProportionalThreshold(double minVoltageDropProportionalThreshold)