com.powsybl.sensitivity

Class SensitivityFactor<F extends SensitivityFunction,V extends SensitivityVariable>

java.lang.Object

com.powsybl.sensitivity.SensitivityFactor<F,V>

Direct Known Subclasses:

BranchFlowPerInjectionIncrease, BranchFlowPerLinearGlsk, BranchFlowPerPSTAngle, BranchIntensityPerPSTAngle

public class SensitivityFactor<F extends SensitivityFunction,V extends SensitivityVariable>
extends java.lang.Object

Basic abstract implementation of sensitivity factors

Must be subclassed to get a business meaning, helping for computation of sensitivity factors in computation engines.

Author:

Sebastien Murgey <sebastien.murgey at rte-france.com>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SensitivityFactor(F sensitivityFunction, V sensitivityVariable) Sensitivity factor standard implementation constructor.

Method Summary

Modifier and Type	Method and Description
F	getFunction() Get the function of the sensitivity factor
V	getVariable() Get the variable of the sensitivity factor

Methods inherited from class java.lang.Object

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

Constructor Detail

SensitivityFactor

protected SensitivityFactor(F sensitivityFunction,
                            V sensitivityVariable)

Sensitivity factor standard implementation constructor.

Parameters:

sensitivityFunction - sensitivity function

sensitivityVariable - sensitivity variable

Method Detail

getFunction

public F getFunction()

Get the function of the sensitivity factor

Returns:

the function of the sensitivity factor

getVariable

public V getVariable()

Get the variable of the sensitivity factor

Returns:

the variable of the sensitivity factor