SweAdditionalConstraintSeriesCreatorTest.java
/*
* Copyright (c) 2022, 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/.
*/
package com.powsybl.openrao.data.raoresult.io.cne.swe;
import com.powsybl.contingency.Contingency;
import com.powsybl.openrao.commons.Unit;
import com.powsybl.openrao.data.crac.api.Crac;
import com.powsybl.openrao.data.crac.api.Instant;
import com.powsybl.openrao.data.crac.api.InstantKind;
import com.powsybl.openrao.data.crac.api.State;
import com.powsybl.openrao.data.crac.api.cnec.AngleCnec;
import com.powsybl.openrao.data.crac.io.cim.craccreator.CimCracCreationContext;
import com.powsybl.openrao.data.crac.io.cim.craccreator.AngleCnecCreationContext;
import com.powsybl.openrao.data.raoresult.api.ComputationStatus;
import com.powsybl.openrao.data.raoresult.api.RaoResult;
import com.powsybl.openrao.data.raoresult.io.cne.swe.xsd.AdditionalConstraintSeries;
import com.powsybl.openrao.monitoring.results.RaoResultWithAngleMonitoring;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import java.util.*;
import static org.junit.jupiter.api.Assertions.assertEquals;
/**
* @author Godelaine de Montmorillon {@literal <godelaine.demontmorillon at rte-france.com>}
*/
class SweAdditionalConstraintSeriesCreatorTest {
private SweCneHelper sweCneHelper;
private Crac crac;
private RaoResult raoResult;
private CimCracCreationContext cracCreationContext;
private Instant preventiveInstant;
private Instant outageInstant;
private Instant autoInstant;
private Instant curativeInstant;
@BeforeEach
public void setup() {
this.crac = Mockito.mock(Crac.class);
this.raoResult = Mockito.mock(RaoResultWithAngleMonitoring.class);
Mockito.when(raoResult.getComputationStatus()).thenReturn(ComputationStatus.DEFAULT);
preventiveInstant = Mockito.mock(Instant.class);
outageInstant = Mockito.mock(Instant.class);
autoInstant = Mockito.mock(Instant.class);
curativeInstant = Mockito.mock(Instant.class);
Mockito.when(crac.getInstant(InstantKind.PREVENTIVE)).thenReturn(preventiveInstant);
Mockito.when(crac.getInstant(InstantKind.OUTAGE)).thenReturn(outageInstant);
Mockito.when(crac.getInstant(InstantKind.AUTO)).thenReturn(autoInstant);
Mockito.when(crac.getInstant(InstantKind.CURATIVE)).thenReturn(curativeInstant);
Mockito.when(curativeInstant.isCurative()).thenReturn(true);
this.cracCreationContext = Mockito.mock(CimCracCreationContext.class);
this.sweCneHelper = Mockito.mock(SweCneHelper.class);
Mockito.when(sweCneHelper.getCrac()).thenReturn(crac);
Mockito.when(sweCneHelper.getRaoResult()).thenReturn(raoResult);
}
private SweAdditionalConstraintSeriesCreator setUpAngleCnecs(Contingency contingency) {
Mockito.when(contingency.getId()).thenReturn("contingency");
AngleCnecCreationContext acc1 = createAdcs("AngleCnecId1", "contingency");
AngleCnecCreationContext acc2 = createAdcs("AngleCnecId2", "contingency");
AngleCnec angleCnec1 = Mockito.mock(AngleCnec.class);
AngleCnec angleCnec2 = Mockito.mock(AngleCnec.class);
Mockito.when(crac.getAngleCnec(acc1.getCreatedObjectId())).thenReturn(angleCnec1);
Mockito.when(crac.getAngleCnec(acc2.getCreatedObjectId())).thenReturn(angleCnec2);
Mockito.when(angleCnec1.getName()).thenReturn("AngleCnecName1");
Mockito.when(angleCnec2.getName()).thenReturn("AngleCnecName2");
Mockito.when(raoResult.getAngle(curativeInstant, angleCnec1, Unit.DEGREE)).thenReturn(1.37);
Mockito.when(raoResult.getAngle(curativeInstant, angleCnec2, Unit.DEGREE)).thenReturn(-21.34);
Mockito.when(cracCreationContext.getAngleCnecCreationContexts()).thenReturn(Set.of(acc1, acc2));
State curativeState = Mockito.mock(State.class);
Mockito.when(curativeState.getInstant()).thenReturn(curativeInstant);
Mockito.when(angleCnec1.getState()).thenReturn(curativeState);
Mockito.when(angleCnec2.getState()).thenReturn(curativeState);
return new SweAdditionalConstraintSeriesCreator(sweCneHelper, cracCreationContext);
}
private void setUpNanAngleCnecs(Contingency contingency) {
Mockito.when(contingency.getId()).thenReturn("contingency");
AngleCnecCreationContext acc1 = createAdcs("AngleCnecId1", "contingency");
AngleCnecCreationContext acc2 = createAdcs("AngleCnecId2", "contingency");
AngleCnec angleCnec1 = Mockito.mock(AngleCnec.class);
AngleCnec angleCnec2 = Mockito.mock(AngleCnec.class);
Mockito.when(crac.getAngleCnec(acc1.getCreatedObjectId())).thenReturn(angleCnec1);
Mockito.when(crac.getAngleCnec(acc2.getCreatedObjectId())).thenReturn(angleCnec2);
Mockito.when(angleCnec1.getName()).thenReturn("AngleCnecName1");
Mockito.when(angleCnec2.getName()).thenReturn("AngleCnecName2");
Mockito.when(raoResult.getAngle(curativeInstant, angleCnec1, Unit.DEGREE)).thenReturn(Double.NaN);
Mockito.when(raoResult.getAngle(curativeInstant, angleCnec2, Unit.DEGREE)).thenReturn(Double.NaN);
Mockito.when(cracCreationContext.getAngleCnecCreationContexts()).thenReturn(Set.of(acc1, acc2));
State curativeState = Mockito.mock(State.class);
Mockito.when(curativeState.getInstant()).thenReturn(curativeInstant);
Mockito.when(angleCnec1.getState()).thenReturn(curativeState);
Mockito.when(angleCnec2.getState()).thenReturn(curativeState);
}
@Test
void generatePreventiveAdditionalConstraintSeriesTest() {
AngleCnecCreationContext accPrev = createAdcs("AngleCnecIdPrev", null);
AngleCnec angleCnecPrev = Mockito.mock(AngleCnec.class);
Mockito.when(crac.getAngleCnec(accPrev.getCreatedObjectId())).thenReturn(angleCnecPrev);
Mockito.when(angleCnecPrev.getName()).thenReturn("AngleCnecNamePrev");
State prevState = Mockito.mock(State.class);
Mockito.when(prevState.getInstant()).thenReturn(preventiveInstant);
Mockito.when(angleCnecPrev.getState()).thenReturn(prevState);
Mockito.when(cracCreationContext.getAngleCnecCreationContexts()).thenReturn(Set.of(accPrev));
SweAdditionalConstraintSeriesCreator additionalConstraintSeriesCreator = new SweAdditionalConstraintSeriesCreator(sweCneHelper, cracCreationContext);
List<AdditionalConstraintSeries> basecaseAngleSeries = additionalConstraintSeriesCreator.generateAdditionalConstraintSeries(null);
assertEquals(0, basecaseAngleSeries.size());
}
@Test
void generateWrongPostContingencyAdditionalConstraintSeriesTest() {
AngleCnecCreationContext accOutage = createAdcs("AngleCnecIdOutage", "contingency");
AngleCnecCreationContext accAuto = createAdcs("AngleCnecIdAuto", "contingency");
AngleCnec angleCnecOutage = Mockito.mock(AngleCnec.class);
AngleCnec angleCnecAuto = Mockito.mock(AngleCnec.class);
Mockito.when(crac.getAngleCnec(accOutage.getCreatedObjectId())).thenReturn(angleCnecOutage);
Mockito.when(crac.getAngleCnec(accAuto.getCreatedObjectId())).thenReturn(angleCnecAuto);
Mockito.when(angleCnecOutage.getName()).thenReturn("AngleCnecNameOutage");
State outageState = Mockito.mock(State.class);
Mockito.when(outageState.getInstant()).thenReturn(outageInstant);
Mockito.when(angleCnecOutage.getState()).thenReturn(outageState);
Mockito.when(angleCnecAuto.getName()).thenReturn("AngleCnecNameAuto");
State autoState = Mockito.mock(State.class);
Mockito.when(autoState.getInstant()).thenReturn(autoInstant);
Mockito.when(angleCnecAuto.getState()).thenReturn(autoState);
Mockito.when(cracCreationContext.getAngleCnecCreationContexts()).thenReturn(Set.of(accOutage, accAuto));
SweAdditionalConstraintSeriesCreator additionalConstraintSeriesCreator = new SweAdditionalConstraintSeriesCreator(sweCneHelper, cracCreationContext);
Contingency contingency = Mockito.mock(Contingency.class);
Mockito.when(contingency.getId()).thenReturn("contingency");
List<AdditionalConstraintSeries> otherAngleSeries = additionalConstraintSeriesCreator.generateAdditionalConstraintSeries(contingency);
assertEquals(0, otherAngleSeries.size());
}
@Test
void generateContingencyAdditionalConstraintSeriesTest() {
Contingency contingency = Mockito.mock(Contingency.class);
SweAdditionalConstraintSeriesCreator additionalConstraintSeriesCreator = setUpAngleCnecs(contingency);
List<AdditionalConstraintSeries> contingencyAngleSeries = additionalConstraintSeriesCreator.generateAdditionalConstraintSeries(contingency);
assertEquals(2, contingencyAngleSeries.size());
assertEquals("AngleCnecId1", contingencyAngleSeries.get(0).getMRID());
assertEquals("AngleCnecName1", contingencyAngleSeries.get(0).getName());
assertEquals("B87", contingencyAngleSeries.get(0).getBusinessType());
assertEquals(1.4, contingencyAngleSeries.get(0).getQuantityQuantity().doubleValue(), 1.0E-6);
assertEquals("AngleCnecId2", contingencyAngleSeries.get(1).getMRID());
assertEquals("AngleCnecName2", contingencyAngleSeries.get(1).getName());
assertEquals("B87", contingencyAngleSeries.get(1).getBusinessType());
assertEquals(-21.3, contingencyAngleSeries.get(1).getQuantityQuantity().doubleValue(), 1.0E-6);
}
@Test
void noGenerateContingencyAdditionalConstraintSeriesWithDivergentAngleMonitoringIfFailureTest() {
Contingency contingency = Mockito.mock(Contingency.class);
Mockito.when(raoResult.getComputationStatus()).thenReturn(ComputationStatus.FAILURE);
setUpAngleCnecs(contingency);
SweAdditionalConstraintSeriesCreator additionalConstraintSeriesCreator = new SweAdditionalConstraintSeriesCreator(sweCneHelper, cracCreationContext);
List<AdditionalConstraintSeries> contingencyAngleSeries = additionalConstraintSeriesCreator.generateAdditionalConstraintSeries(contingency);
assertEquals(0, contingencyAngleSeries.size());
}
@Test
void noGenerateContingencyAdditionalConstraintSeriesWithDivergentAngleMonitoringIfNoAngleTest() {
Contingency contingency = Mockito.mock(Contingency.class);
Mockito.when(raoResult.getComputationStatus()).thenReturn(ComputationStatus.DEFAULT);
setUpNanAngleCnecs(contingency);
SweAdditionalConstraintSeriesCreator additionalConstraintSeriesCreator = new SweAdditionalConstraintSeriesCreator(sweCneHelper, cracCreationContext);
List<AdditionalConstraintSeries> contingencyAngleSeries = additionalConstraintSeriesCreator.generateAdditionalConstraintSeries(contingency);
assertEquals(0, contingencyAngleSeries.size());
}
private AngleCnecCreationContext createAdcs(String nativeId, String contingencyId) {
AngleCnecCreationContext acc = Mockito.mock(AngleCnecCreationContext.class);
Mockito.when(acc.getCreatedObjectId()).thenReturn(nativeId);
Mockito.when(acc.getContingencyId()).thenReturn(contingencyId);
Mockito.when(acc.isImported()).thenReturn(true);
return acc;
}
@Test
void testRoundAngleValue() {
AngleCnec angleCnecWithMax = Mockito.mock(AngleCnec.class);
Mockito.when(angleCnecWithMax.getUpperBound(Unit.DEGREE)).thenReturn(Optional.of(40.0));
Mockito.when(angleCnecWithMax.getLowerBound(Unit.DEGREE)).thenReturn(Optional.empty());
AngleCnec angleCnecWithMin = Mockito.mock(AngleCnec.class);
Mockito.when(angleCnecWithMin.getUpperBound(Unit.DEGREE)).thenReturn(Optional.empty());
Mockito.when(angleCnecWithMin.getLowerBound(Unit.DEGREE)).thenReturn(Optional.of(39.0));
AngleCnec angleCnecWithMaxAndMin = Mockito.mock(AngleCnec.class);
Mockito.when(angleCnecWithMaxAndMin.getUpperBound(Unit.DEGREE)).thenReturn(Optional.of(40.0));
Mockito.when(angleCnecWithMaxAndMin.getLowerBound(Unit.DEGREE)).thenReturn(Optional.of(39.0));
Crac mockCrac = Mockito.mock(Crac.class);
RaoResult mockRaoResult = Mockito.mock(RaoResult.class);
Instant mockCurativeInstant = Mockito.mock(Instant.class);
Mockito.when(mockCrac.getInstant(InstantKind.CURATIVE)).thenReturn(mockCurativeInstant);
// No violation -> 1 decimal
Mockito.when(mockRaoResult.getAngle(mockCurativeInstant, angleCnecWithMax, Unit.DEGREE)).thenReturn(39.5);
Assertions.assertEquals(39.5, SweAdditionalConstraintSeriesCreator.roundAngleValue(angleCnecWithMax, mockCrac, mockRaoResult).doubleValue());
Assertions.assertEquals(1, SweAdditionalConstraintSeriesCreator.roundAngleValue(angleCnecWithMax, mockCrac, mockRaoResult).scale());
// Big violation -> 1 decimal
Mockito.when(mockRaoResult.getAngle(mockCurativeInstant, angleCnecWithMin, Unit.DEGREE)).thenReturn(35.0);
Assertions.assertEquals(35.0, SweAdditionalConstraintSeriesCreator.roundAngleValue(angleCnecWithMin, mockCrac, mockRaoResult).doubleValue());
Assertions.assertEquals(1, SweAdditionalConstraintSeriesCreator.roundAngleValue(angleCnecWithMin, mockCrac, mockRaoResult).scale());
// 0.002 violation -> 3 decimals
Mockito.when(mockRaoResult.getAngle(mockCurativeInstant, angleCnecWithMaxAndMin, Unit.DEGREE)).thenReturn(40.002);
Assertions.assertEquals(40.002, SweAdditionalConstraintSeriesCreator.roundAngleValue(angleCnecWithMaxAndMin, mockCrac, mockRaoResult).doubleValue());
Assertions.assertEquals(3, SweAdditionalConstraintSeriesCreator.roundAngleValue(angleCnecWithMaxAndMin, mockCrac, mockRaoResult).scale());
// 0.00007 violation -> 5 decimals
Mockito.when(mockRaoResult.getAngle(mockCurativeInstant, angleCnecWithMaxAndMin, Unit.DEGREE)).thenReturn(38.99993);
Assertions.assertEquals(38.99993, SweAdditionalConstraintSeriesCreator.roundAngleValue(angleCnecWithMaxAndMin, mockCrac, mockRaoResult).doubleValue());
Assertions.assertEquals(5, SweAdditionalConstraintSeriesCreator.roundAngleValue(angleCnecWithMaxAndMin, mockCrac, mockRaoResult).scale());
}
}