AbstractSimpleSensitivityProvider.java
/*
* Copyright (c) 2020, 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.sensitivityanalysis;
import com.powsybl.openrao.commons.OpenRaoException;
import com.powsybl.openrao.commons.Unit;
import com.powsybl.openrao.commons.logs.OpenRaoLoggerProvider;
import com.powsybl.contingency.Contingency;
import com.powsybl.openrao.data.crac.api.cnec.FlowCnec;
import com.powsybl.iidm.network.Network;
import com.powsybl.sensitivity.SensitivityFactor;
import java.util.*;
/**
* @author Philippe Edwards {@literal <philippe.edwards at rte-france.com>}
*/
public abstract class AbstractSimpleSensitivityProvider implements CnecSensitivityProvider {
protected Set<FlowCnec> cnecs;
protected Map<String, ArrayList<FlowCnec> > cnecsPerContingencyId = new HashMap<>();
protected boolean factorsInMegawatt = false;
protected boolean factorsInAmpere = false;
protected boolean afterContingencyOnly = false;
AbstractSimpleSensitivityProvider(Set<FlowCnec> cnecs, Set<Unit> requestedUnits) {
this.cnecs = cnecs;
for (FlowCnec cnec : cnecs) {
if (cnec.getState().isPreventive()) {
cnecsPerContingencyId.computeIfAbsent(null, string -> new ArrayList<>());
cnecsPerContingencyId.get(null).add(cnec);
} else {
String contingencyId = cnec.getState().getContingency().orElseThrow().getId();
cnecsPerContingencyId.computeIfAbsent(contingencyId, string -> new ArrayList<>());
cnecsPerContingencyId.get(contingencyId).add(cnec);
}
}
this.setRequestedUnits(requestedUnits);
}
@Override
public void setRequestedUnits(Set<Unit> requestedUnits) {
factorsInMegawatt = false;
factorsInAmpere = false;
for (Unit unit : requestedUnits) {
switch (unit) {
case MEGAWATT:
factorsInMegawatt = true;
break;
case AMPERE:
factorsInAmpere = true;
break;
default:
OpenRaoLoggerProvider.TECHNICAL_LOGS.warn("Unit {} cannot be handled by the sensitivity provider as it is not a flow unit", unit);
}
}
if (!factorsInAmpere && !factorsInMegawatt) {
throw new OpenRaoException("The sensitivity provider should contain at least Megawatt or Ampere unit");
}
}
@Override
public List<SensitivityFactor> getAllFactors(Network network) {
List<SensitivityFactor> factors = new ArrayList<>();
factors.addAll(getBasecaseFactors(network));
factors.addAll(getContingencyFactors(network, getContingencies(network)));
return new ArrayList<>(factors);
}
public Set<FlowCnec> getFlowCnecs() {
return cnecs;
}
@Override
public List<Contingency> getContingencies(Network network) {
return cnecs.stream()
.filter(cnec -> cnec.getState().getContingency().isPresent())
.map(cnec -> cnec.getState().getContingency().get())
.distinct()
.toList();
}
@Override
public void disableFactorsForBaseCaseSituation() {
this.afterContingencyOnly = true;
}
@Override
public void enableFactorsForBaseCaseSituation() {
this.afterContingencyOnly = false;
}
}