Skip to content

Commit

Permalink
Add OpenReac parameters interface (#43)
Browse files Browse the repository at this point in the history 
* Add two params to control consistency of voltage limits.
* Add interface for min/max voltage limit parameters.
* Add unit test with comparison of input file exported.
* Refactor java code.
* Refactor ampl code.
* Add openreac parameters in OpenReacParameters.
* Add methods to access/set OpenReac parameters.
* Remove algoParam map and replace with OpenReac interfaces.
* Improve unit tests.
* Add last OpenReac parameters in Java.
* Add methods and unit tests.
* Add unit tests and default_param_algo.txt file to OpenReac resources.
* Add comments.
* Rename parameters.
* Revert modifications on ParamAlgoDeserializer.
* Refactor json tests to fix code smell.
* Refactor alphaCoefficient parameter into activePowerVariationRate.

---------

Signed-off-by: parvy <pierre.arvy@artelys.com>
  • Loading branch information
@p-arvy
p-arvy authored Apr 18, 2024
1 parent 5cfbd60 commit 6fd3cc9
Show file tree
Hide file tree
Showing 11 changed files with 620 additions and 50 deletions.
265 changes: 245 additions & 20 deletions open-reac/src/main/java/com/powsybl/openreac/parameters/input/OpenReacParameters.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,46 @@ public class OpenReacParameters {

private ReactiveSlackBusesMode reactiveSlackBusesMode = ReactiveSlackBusesMode.NO_GENERATION;

private static final String ACTIVE_POWER_VARIATION_RATE_KEY = "coeff_alpha";

private double activePowerVariationRate = 1; // in [0;1]

private static final String MIN_PLAUSIBLE_ACTIVE_POWER_THRESHOLD_KEY = "Pnull";

private double minPlausibleActivePowerThreshold = 0.01; // in MW, for detecting zero value for power

private static final String LOW_IMPEDANCE_THRESHOLD_KEY = "Znull";

private double lowImpedanceThreshold = 1e-4; // in p.u., for detecting null impedance branches

private static final String MIN_NOMINAL_VOLTAGE_IGNORED_BUS_KEY = "epsilon_nominal_voltage";

private double minNominalVoltageIgnoredBus = 1; // in kV, to ignore buses with Vnom lower than this value

private static final String MIN_NOMINAL_VOLTAGE_IGNORED_VOLTAGE_BOUNDS_KEY = "ignore_voltage_bounds";

private double minNominalVoltageIgnoredVoltageBounds = 0; // in kV, to ignore voltage bounds of buses with Vnom lower than this value

private static final String MAX_PLAUSIBLE_POWER_LIMIT_KEY = "PQmax";

private double maxPlausiblePowerLimit = 9000; // MW

private static final String HIGH_ACTIVE_POWER_DEFAULT_LIMIT_KEY = "defaultPmax";

private double highActivePowerDefaultLimit = 1000; // MW

private static final String LOW_ACTIVE_POWER_DEFAULT_LIMIT_KEY = "defaultPmin";

private double lowActivePowerDefaultLimit = 0; // MW

private static final String DEFAULT_QMAX_PMAX_RATIO_KEY = "defaultQmaxPmaxRatio";

private double defaultQmaxPmaxRatio = 0.3;

private static final String DEFAULT_MINIMAL_QP_RANGE_KEY = "minimalQPrange";

private double defaultMinimalQPRange = 1;

private static final String DEFAULT_VARIABLE_SCALING_FACTOR = "default_variable_scaling_factor";

private double defaultVariableScalingFactor = 1;
Expand Down Expand Up @@ -85,6 +125,10 @@ public OpenReacParameters addSpecificVoltageLimits(List<VoltageLimitOverride> sp
return this;
}

public List<VoltageLimitOverride> getSpecificVoltageLimits() {
return specificVoltageLimits;
}

/**
* A list of shunt compensators, which susceptance will be considered as variable by the optimizer.
* The optimizer computes a continuous value that is rounded when results are stored in {@link com.powsybl.openreac.parameters.output.OpenReacResult}.
Expand All @@ -94,6 +138,10 @@ public OpenReacParameters addVariableShuntCompensators(List<String> shuntsIds) {
return this;
}

public List<String> getVariableShuntCompensators() {
return variableShuntCompensators;
}

/**
* The reactive power produced by every generator in the list will be constant and equal to `targetQ`.
*/
Expand All @@ -102,6 +150,10 @@ public OpenReacParameters addConstantQGenerators(List<String> generatorsIds) {
return this;
}

public List<String> getConstantQGenerators() {
return constantQGenerators;
}

/**
* A list of two windings transformers, which ratio will be considered as variable by the optimizer.
*/
Expand All @@ -110,6 +162,10 @@ public OpenReacParameters addVariableTwoWindingsTransformers(List<String> transf
return this;
}

public List<String> getVariableTwoWindingsTransformers() {
return variableTwoWindingsTransformers;
}

/**
* A list of buses, to which reactive slacks variable will be attached by the optimizer.
*/
Expand All @@ -118,6 +174,10 @@ public OpenReacParameters addConfiguredReactiveSlackBuses(List<String> busesIds)
return this;
}

public List<String> getConfiguredReactiveSlackBuses() {
return configuredReactiveSlackBuses;
}

/**
* The definition of the objective function for the optimization.
*/
Expand Down Expand Up @@ -232,6 +292,159 @@ public OpenReacParameters setReactiveSlackBusesMode(ReactiveSlackBusesMode react
return this;
}

/**
* @return the weight to favor more/less minimization of active power produced by generators.
*/
public double getActivePowerVariationRate() {
return activePowerVariationRate;
}

public OpenReacParameters setActivePowerVariationRate(double activePowerVariationRate) {
if (Double.isNaN(activePowerVariationRate) || activePowerVariationRate < 0 || activePowerVariationRate > 1) {
throw new IllegalArgumentException("Active power variation rate must be defined and between 0 and 1 to be consistent.");
}
this.activePowerVariationRate = activePowerVariationRate;
return this;
}

/**
* @return the threshold of active and reactive power considered as null.
*/
public double getMinPlausibleActivePowerThreshold() {
return minPlausibleActivePowerThreshold;
}

public OpenReacParameters setMinPlausibleActivePowerThreshold(double minPlausibleActivePowerThreshold) {
if (Double.isNaN(minPlausibleActivePowerThreshold) || minPlausibleActivePowerThreshold < 0) {
throw new IllegalArgumentException("Zero power threshold must be defined and >= 0 to be consistent.");
}
this.minPlausibleActivePowerThreshold = minPlausibleActivePowerThreshold;
return this;
}

/**
* @return the threshold of impedance considered as null.
*/
public double getLowImpedanceThreshold() {
return lowImpedanceThreshold;
}

public OpenReacParameters setLowImpedanceThreshold(double lowImpedanceThreshold) {
if (Double.isNaN(lowImpedanceThreshold) || lowImpedanceThreshold < 0) {
throw new IllegalArgumentException("Zero impedance threshold must be defined and >= 0 to be consistent.");
}
this.lowImpedanceThreshold = lowImpedanceThreshold;
return this;
}

/**
* @return the threshold to ignore voltage levels with nominal voltager lower than it.
*/
public double getMinNominalVoltageIgnoredBus() {
return minNominalVoltageIgnoredBus;
}

public OpenReacParameters setMinNominalVoltageIgnoredBus(double minNominalVoltageIgnoredBus) {
if (Double.isNaN(minNominalVoltageIgnoredBus) || minNominalVoltageIgnoredBus < 0) {
throw new IllegalArgumentException("Nominal threshold for ignored buses must be defined and >= 0 to be consistent.");
}
this.minNominalVoltageIgnoredBus = minNominalVoltageIgnoredBus;
return this;
}

/**
* @return the threshold used to replace voltage limits of voltage levels with nominal voltage
* than it.
*/
public double getMinNominalVoltageIgnoredVoltageBounds() {
return minNominalVoltageIgnoredVoltageBounds;
}

public OpenReacParameters setMinNominalVoltageIgnoredVoltageBounds(double minNominalVoltageIgnoredVoltageBounds) {
if (Double.isNaN(minNominalVoltageIgnoredVoltageBounds) || minNominalVoltageIgnoredVoltageBounds < 0) {
throw new IllegalArgumentException("Nominal threshold for ignored voltage bounds must be defined and >= 0 to be consistent");
}
this.minNominalVoltageIgnoredVoltageBounds = minNominalVoltageIgnoredVoltageBounds;
return this;
}

/**
* @return the threshold for maximum active and reactive power considered in correction of generator limits.
*/
public double getPQMax() {
return maxPlausiblePowerLimit;
}

public OpenReacParameters setPQMax(double pQMax) {
if (Double.isNaN(pQMax) || pQMax <= 0) {
throw new IllegalArgumentException("Maximal consistency value for P and Q must be defined and > 0 to be consistent");
}
this.maxPlausiblePowerLimit = pQMax;
return this;
}

/**
* @return the threshold for correction of high active power limit produced by generators.
*/
public double getHighActivePowerDefaultLimit() {
return highActivePowerDefaultLimit;
}

public OpenReacParameters setHighActivePowerDefaultLimit(double highActivePowerDefaultLimit) {
if (Double.isNaN(highActivePowerDefaultLimit) || highActivePowerDefaultLimit <= 0) {
throw new IllegalArgumentException("Default P max value must be defined and > 0 to be consistent.");
}
this.highActivePowerDefaultLimit = highActivePowerDefaultLimit;
return this;
}

/**
* @return the threshold for correction of low active power limit produced by generators.
*/
public double getLowActivePowerDefaultLimit() {
return lowActivePowerDefaultLimit;
}

public OpenReacParameters setLowActivePowerDefaultLimit(double lowActivePowerDefaultLimit) {
if (Double.isNaN(lowActivePowerDefaultLimit) || lowActivePowerDefaultLimit < 0) {
throw new IllegalArgumentException("Default P min value must be defined and >= 0 to be consistent.");
}
this.lowActivePowerDefaultLimit = lowActivePowerDefaultLimit;
return this;
}

/**
* @return the ratio used to calculate threshold for corrections of high/low reactive power limits.
*/
public double getDefaultQmaxPmaxRatio() {
return defaultQmaxPmaxRatio;
}

public OpenReacParameters setDefaultQmaxPmaxRatio(double defaultQmaxPmaxRatio) {
// Qmin/Qmax are computed with this value in OpenReac, can not be zero
if (Double.isNaN(defaultQmaxPmaxRatio) || defaultQmaxPmaxRatio <= 0) {
throw new IllegalArgumentException("Default Qmax and Pmax ratio must be defined and > 0 to be consistent.");
}
this.defaultQmaxPmaxRatio = defaultQmaxPmaxRatio;
return this;
}

/**
* @return the threshold to fix active (resp. reactive) power of generators with
* active (resp. reactive) power limits that are closer than it.
*/
public double getDefaultMinimalQPRange() {
return defaultMinimalQPRange;
}

public OpenReacParameters setDefaultMinimalQPRange(double defaultMinimalQPRange) {
if (Double.isNaN(defaultMinimalQPRange) || defaultMinimalQPRange < 0) {
throw new IllegalArgumentException("Default minimal QP range must be defined and >= 0 to be consistent.");
}
this.defaultMinimalQPRange = defaultMinimalQPRange;
return this;
}

/**
* @return the default scaling value of all the variables in ACOPF solving.
*/
Expand Down Expand Up @@ -292,26 +505,6 @@ public OpenReacParameters setTwoWindingTransformerRatioVariableScalingFactor(dou
return this;
}

public List<String> getVariableShuntCompensators() {
return variableShuntCompensators;
}

public List<VoltageLimitOverride> getSpecificVoltageLimits() {
return specificVoltageLimits;
}

public List<String> getConstantQGenerators() {
return constantQGenerators;
}

public List<String> getVariableTwoWindingsTransformers() {
return variableTwoWindingsTransformers;
}

public List<String> getConfiguredReactiveSlackBuses() {
return configuredReactiveSlackBuses;
}

public List<OpenReacAlgoParam> getAllAlgorithmParams() {
ArrayList<OpenReacAlgoParam> allAlgoParams = new ArrayList<>();
allAlgoParams.add(objective.toParam());
Expand All @@ -323,6 +516,16 @@ public List<OpenReacAlgoParam> getAllAlgorithmParams() {
allAlgoParams.add(new OpenReacAlgoParamImpl(MIN_PLAUSIBLE_LOW_VOLTAGE_LIMIT_KEY, Double.toString(minPlausibleLowVoltageLimit)));
allAlgoParams.add(new OpenReacAlgoParamImpl(MAX_PLAUSIBLE_HIGH_VOLTAGE_LIMIT_KEY, Double.toString(maxPlausibleHighVoltageLimit)));
allAlgoParams.add(reactiveSlackBusesMode.toParam());
allAlgoParams.add(new OpenReacAlgoParamImpl(ACTIVE_POWER_VARIATION_RATE_KEY, Double.toString(activePowerVariationRate)));
allAlgoParams.add(new OpenReacAlgoParamImpl(MIN_PLAUSIBLE_ACTIVE_POWER_THRESHOLD_KEY, Double.toString(minPlausibleActivePowerThreshold)));
allAlgoParams.add(new OpenReacAlgoParamImpl(LOW_IMPEDANCE_THRESHOLD_KEY, Double.toString(lowImpedanceThreshold)));
allAlgoParams.add(new OpenReacAlgoParamImpl(MIN_NOMINAL_VOLTAGE_IGNORED_BUS_KEY, Double.toString(minNominalVoltageIgnoredBus)));
allAlgoParams.add(new OpenReacAlgoParamImpl(MIN_NOMINAL_VOLTAGE_IGNORED_VOLTAGE_BOUNDS_KEY, Double.toString(minNominalVoltageIgnoredVoltageBounds)));
allAlgoParams.add(new OpenReacAlgoParamImpl(MAX_PLAUSIBLE_POWER_LIMIT_KEY, Double.toString(maxPlausiblePowerLimit)));
allAlgoParams.add(new OpenReacAlgoParamImpl(LOW_ACTIVE_POWER_DEFAULT_LIMIT_KEY, Double.toString(lowActivePowerDefaultLimit)));
allAlgoParams.add(new OpenReacAlgoParamImpl(HIGH_ACTIVE_POWER_DEFAULT_LIMIT_KEY, Double.toString(highActivePowerDefaultLimit)));
allAlgoParams.add(new OpenReacAlgoParamImpl(DEFAULT_QMAX_PMAX_RATIO_KEY, Double.toString(defaultQmaxPmaxRatio)));
allAlgoParams.add(new OpenReacAlgoParamImpl(DEFAULT_MINIMAL_QP_RANGE_KEY, Double.toString(defaultMinimalQPRange)));
allAlgoParams.add(new OpenReacAlgoParamImpl(DEFAULT_VARIABLE_SCALING_FACTOR, Double.toString(defaultVariableScalingFactor)));
allAlgoParams.add(new OpenReacAlgoParamImpl(DEFAULT_CONSTRAINT_SCALING_FACTOR, Double.toString(defaultConstraintScalingFactor)));
allAlgoParams.add(new OpenReacAlgoParamImpl(REACTIVE_SLACK_VARIABLE_SCALING_FACTOR, Double.toString(reactiveSlackVariableScalingFactor)));
Expand Down Expand Up @@ -395,6 +598,28 @@ public boolean checkAlgorithmParametersIntegrity() {
integrityAlgorithmParameters = false;
}

if (lowActivePowerDefaultLimit > highActivePowerDefaultLimit) {
LOGGER.warn("Default P min = {} must be lower than default P max = {} to be consistent.",
lowActivePowerDefaultLimit, highActivePowerDefaultLimit);
integrityAlgorithmParameters = false;
}

if (highActivePowerDefaultLimit > maxPlausiblePowerLimit) {
LOGGER.warn("Default P min = {} and default P max = {} must be lower than PQmax value = {} to be consistent.",
lowActivePowerDefaultLimit, highActivePowerDefaultLimit, maxPlausiblePowerLimit);
integrityAlgorithmParameters = false;
}

if (highActivePowerDefaultLimit * defaultQmaxPmaxRatio > maxPlausiblePowerLimit) {
LOGGER.warn("Default Q max value = {} value must be lower than PQmax value to be consistent.",
highActivePowerDefaultLimit * defaultQmaxPmaxRatio);
integrityAlgorithmParameters = false;
}

if (minNominalVoltageIgnoredBus > minNominalVoltageIgnoredVoltageBounds) {
LOGGER.warn("Some buses with ignored voltage bounds will be ignored in calculations.");
}

return integrityAlgorithmParameters;
}

Expand Down
40 changes: 40 additions & 0 deletions .../main/java/com/powsybl/openreac/parameters/input/json/OpenReacParametersDeserializer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,46 @@ public OpenReacParameters deserialize(JsonParser parser, DeserializationContext
parser.nextToken();
parameters.setReactiveSlackBusesMode(ReactiveSlackBusesMode.valueOf(parser.getText()));
}
case "activePowerVariationRate" -> {
parser.nextToken();
parameters.setActivePowerVariationRate(parser.getValueAsDouble());
}
case "minPlausibleActivePowerThreshold" -> {
parser.nextToken();
parameters.setMinPlausibleActivePowerThreshold(parser.getValueAsDouble());
}
case "lowImpedanceThreshold" -> {
parser.nextToken();
parameters.setLowImpedanceThreshold(parser.getValueAsDouble());
}
case "minNominalVoltageIgnoredBus" -> {
parser.nextToken();
parameters.setMinNominalVoltageIgnoredBus(parser.getValueAsDouble());
}
case "minNominalVoltageIgnoredVoltageBounds" -> {
parser.nextToken();
parameters.setMinNominalVoltageIgnoredVoltageBounds(parser.getValueAsDouble());
}
case "maxPlausiblePowerLimit" -> {
parser.nextToken();
parameters.setPQMax(parser.getValueAsDouble());
}
case "lowActivePowerDefaultLimit" -> {
parser.nextToken();
parameters.setLowActivePowerDefaultLimit(parser.getValueAsDouble());
}
case "highActivePowerDefaultLimit" -> {
parser.nextToken();
parameters.setHighActivePowerDefaultLimit(parser.getValueAsDouble());
}
case "defaultQmaxPmaxRatio" -> {
parser.nextToken();
parameters.setDefaultQmaxPmaxRatio(parser.getValueAsDouble());
}
case "defaultMinimalQPRange" -> {
parser.nextToken();
parameters.setDefaultMinimalQPRange(parser.getValueAsDouble());
}
case "defaultVariableScalingFactor" -> {
parser.nextToken();
parameters.setDefaultVariableScalingFactor(parser.readValueAs(Double.class));
Expand Down
10 changes: 10 additions & 0 deletions ...rc/main/java/com/powsybl/openreac/parameters/input/json/OpenReacParametersSerializer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ public void serialize(OpenReacParameters openReacParameters, JsonGenerator jsonG
serializerProvider.defaultSerializeField("minPlausibleLowVoltageLimit", openReacParameters.getMinPlausibleLowVoltageLimit(), jsonGenerator);
serializerProvider.defaultSerializeField("maxPlausibleHighVoltageLimit", openReacParameters.getMaxPlausibleHighVoltageLimit(), jsonGenerator);
serializerProvider.defaultSerializeField("reactiveSlackBusesMode", openReacParameters.getReactiveSlackBusesMode().name(), jsonGenerator);
serializerProvider.defaultSerializeField("activePowerVariationRate", openReacParameters.getActivePowerVariationRate(), jsonGenerator);
serializerProvider.defaultSerializeField("minPlausibleActivePowerThreshold", openReacParameters.getMinPlausibleActivePowerThreshold(), jsonGenerator);
serializerProvider.defaultSerializeField("lowImpedanceThreshold", openReacParameters.getLowImpedanceThreshold(), jsonGenerator);
serializerProvider.defaultSerializeField("minNominalVoltageIgnoredBus", openReacParameters.getMinNominalVoltageIgnoredBus(), jsonGenerator);
serializerProvider.defaultSerializeField("minNominalVoltageIgnoredVoltageBounds", openReacParameters.getMinNominalVoltageIgnoredVoltageBounds(), jsonGenerator);
serializerProvider.defaultSerializeField("maxPlausiblePowerLimit", openReacParameters.getPQMax(), jsonGenerator);
serializerProvider.defaultSerializeField("lowActivePowerDefaultLimit", openReacParameters.getLowActivePowerDefaultLimit(), jsonGenerator);
serializerProvider.defaultSerializeField("highActivePowerDefaultLimit", openReacParameters.getHighActivePowerDefaultLimit(), jsonGenerator);
serializerProvider.defaultSerializeField("defaultQmaxPmaxRatio", openReacParameters.getDefaultQmaxPmaxRatio(), jsonGenerator);
serializerProvider.defaultSerializeField("defaultMinimalQPRange", openReacParameters.getDefaultMinimalQPRange(), jsonGenerator);
serializerProvider.defaultSerializeField("defaultVariableScalingFactor", openReacParameters.getDefaultVariableScalingFactor(), jsonGenerator);
serializerProvider.defaultSerializeField("defaultConstraintScalingFactor", openReacParameters.getDefaultConstraintScalingFactor(), jsonGenerator);
serializerProvider.defaultSerializeField("reactiveSlackVariableScalingFactor", openReacParameters.getReactiveSlackVariableScalingFactor(), jsonGenerator);
Expand Down
Loading

0 comments on commit 6fd3cc9

Please sign in to comment.