ObjectiveFunctionCreator.java

/*
 * Copyright (c) 2024, 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.searchtreerao.commons.objectivefunction;

import com.powsybl.openrao.data.crac.api.State;
import com.powsybl.openrao.data.crac.api.cnec.Cnec;
import com.powsybl.openrao.data.crac.api.cnec.FlowCnec;
import com.powsybl.openrao.raoapi.parameters.LoopFlowParameters;
import com.powsybl.openrao.raoapi.parameters.MnecParameters;
import com.powsybl.openrao.raoapi.parameters.RaoParameters;
import com.powsybl.openrao.raoapi.parameters.extensions.*;
import com.powsybl.openrao.searchtreerao.commons.marginevaluator.MarginEvaluator;
import com.powsybl.openrao.searchtreerao.commons.marginevaluator.MarginEvaluatorWithMarginDecreaseUnoptimizedCnecs;
import com.powsybl.openrao.searchtreerao.commons.objectivefunctionevaluator.*;
import com.powsybl.openrao.searchtreerao.result.api.FlowResult;

import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * @author Thomas Bouquet {@literal <thomas.bouquet at rte-france.com>}
 */
public class ObjectiveFunctionCreator extends AbstractObjectiveFunctionCreator {
    private final Set<FlowCnec> loopFlowCnecs;
    private final FlowResult initialFlowResult;
    private final FlowResult prePerimeterFlowResult;
    private final Set<String> operatorsNotToOptimizeInCurative;

    protected ObjectiveFunctionCreator(Set<FlowCnec> flowCnecs, Set<State> optimizedStates, RaoParameters raoParameters, Set<FlowCnec> loopFlowCnecs, FlowResult initialFlowResult, FlowResult prePerimeterFlowResult, Set<String> operatorsNotToOptimizeInCurative) {
        super(flowCnecs, optimizedStates, raoParameters);
        this.loopFlowCnecs = loopFlowCnecs;
        this.initialFlowResult = initialFlowResult;
        this.prePerimeterFlowResult = prePerimeterFlowResult;
        this.operatorsNotToOptimizeInCurative = operatorsNotToOptimizeInCurative;
    }

    @Override
    protected MarginEvaluator getMarginEvaluator() {
        // Unoptimized cnecs in operatorsNotToOptimizeInCurative countries
        return raoParameters.getNotOptimizedCnecsParameters().getDoNotOptimizeCurativeCnecsForTsosWithoutCras() && !operatorsNotToOptimizeInCurative.isEmpty() ? new MarginEvaluatorWithMarginDecreaseUnoptimizedCnecs(super.getMarginEvaluator(), operatorsNotToOptimizeInCurative, prePerimeterFlowResult) : super.getMarginEvaluator();
    }

    @Override
    protected List<CostEvaluator> getVirtualCostEvaluators(MarginEvaluator marginEvaluator) {
        List<CostEvaluator> virtualCostEvaluators = new ArrayList<>();

        if (raoParameters.getObjectiveFunctionParameters().getType().costOptimization()) {
            SearchTreeRaoCostlyMinMarginParameters minMarginsParametersOptional = raoParameters.getExtension(OpenRaoSearchTreeParameters.class).getMinMarginsParameters().orElseThrow();
            virtualCostEvaluators.add(new MinMarginViolationEvaluator(flowCnecs, unit, marginEvaluator, minMarginsParametersOptional.getShiftedViolationPenalty()));
        }

        // mnec virtual cost evaluator
        if (raoParameters.hasExtension(OpenRaoSearchTreeParameters.class)) {
            Optional<MnecParameters> mnecParametersOptional = raoParameters.getMnecParameters();
            Optional<SearchTreeRaoMnecParameters> mnecParametersExtensionOptional = raoParameters.getExtension(OpenRaoSearchTreeParameters.class).getMnecParameters();
            if (mnecParametersOptional.isPresent() && mnecParametersExtensionOptional.isPresent()) {
                virtualCostEvaluators.add(new MnecViolationCostEvaluator(
                    flowCnecs.stream().filter(Cnec::isMonitored).collect(Collectors.toSet()),
                    raoParameters.getObjectiveFunctionParameters().getUnit(),
                    initialFlowResult,
                    mnecParametersOptional.get().getAcceptableMarginDecrease(),
                    mnecParametersExtensionOptional.get().getViolationCost()
                ));
            }
        }

        // loop-flow virtual cost evaluator
        if (raoParameters.hasExtension(OpenRaoSearchTreeParameters.class)) {
            Optional<LoopFlowParameters> loopFlowParametersOptional = raoParameters.getLoopFlowParameters();
            Optional<SearchTreeRaoLoopFlowParameters> loopFlowParametersExtensionOptional = raoParameters.getExtension(OpenRaoSearchTreeParameters.class).getLoopFlowParameters();
            if (loopFlowParametersOptional.isPresent() && loopFlowParametersExtensionOptional.isPresent()) {
                virtualCostEvaluators.add(new LoopFlowViolationCostEvaluator(
                    loopFlowCnecs,
                    initialFlowResult,
                    loopFlowParametersOptional.get().getAcceptableIncrease(),
                    loopFlowParametersExtensionOptional.get().getViolationCost()
                ));
            }
        }

        // If sensi failed, create a high virtual cost via SensitivityFailureOvercostEvaluator
        // to ensure that corresponding leaf is not selected
        if (LoadFlowAndSensitivityParameters.getSensitivityFailureOvercost(raoParameters) > 0) {
            virtualCostEvaluators.add(new SensitivityFailureOvercostEvaluator(flowCnecs, LoadFlowAndSensitivityParameters.getSensitivityFailureOvercost(raoParameters)));
        }

        return virtualCostEvaluators;
    }
}