Skip to content

Commit

Permalink
Fix doc for sensitivity thresholds (#2511)
Browse files Browse the repository at this point in the history
Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>
  • Loading branch information
obrix authored and miovd committed Mar 30, 2023
1 parent 10fa103 commit 56dc5e0
Showing 1 changed file with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@ public SensitivityAnalysisParameters setVoltageVoltageSensitivityValueThreshold(

/**
* VoltageVoltageSensitivityValueThreshold is the threshold under which sensitivity values having
* variable type BUS_TARGET_VOLTAGE and function type BUS_VOLTAGE will be filtered from the analysis results.
* variable type BUS_TARGET_VOLTAGE
* and function type BUS_VOLTAGE will be filtered from the analysis results.
* @return The threshold
*/
public double getVoltageVoltageSensitivityValueThreshold() {
Expand All @@ -107,10 +108,10 @@ public SensitivityAnalysisParameters setFlowVoltageSensitivityValueThreshold(dou
}

/**
* FlowVoltageSensitivityValueThreshold is the threshold under which sensitivity values having
* variable type among INJECTION_REACTIVE_POWER and BUS_TARGET_VOLTAGE
* and function type among BUS_VOLTAGE, BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3
* will be filtered from the analysis results.
* FlowVoltageSensitivityValueThreshold is the threshold under which sensitivity values
* having variable type among INJECTION_REACTIVE_POWER and function type among BUS_VOLTAGE
* or variable type among BUS_TARGET_VOLTAGE and function type among
* BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3 will be filtered from the analysis results.
* @return The threshold
*/
public double getFlowVoltageSensitivityValueThreshold() {
Expand Down

0 comments on commit 56dc5e0

Please sign in to comment.