adq-patch-params.h

/*
 * Copyright 2007-2025, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
#pragma once
 
#include <string>
#include <vector>
 
#include <yuni/core/string.h>
 
#include <antares/inifile/inifile.h>
#include <antares/study/fwd.h>
#include "antares/exception/LoadingError.hpp"
 
namespace Antares::Error
{
class NoAreaInsideAdqPatchMode final: public LoadingError
{
public:
    NoAreaInsideAdqPatchMode();
};
 
class IncompatibleHurdleCostCSR final: public LoadingError
{
public:
    IncompatibleHurdleCostCSR();
};
 
class IncompatibleSimulationModeForAdqPatch final: public LoadingError
{
public:
    IncompatibleSimulationModeForAdqPatch();
};
 
} // namespace Antares::Error
 
namespace Antares::Data::AdequacyPatch
{
const double defaultThresholdToRunCurtailmentSharing = 0.0;
const double defaultThresholdDisplayLocalMatchingRuleViolations = 0.0;
const int defaultValueThresholdVarBoundsRelaxation = 3;
 
enum AdequacyPatchMode
{
    virtualArea = 0,
    physicalAreaOutsideAdqPatch = 1,
    physicalAreaInsideAdqPatch = 2
}; // enum AdequacyPatchMode
 
enum class AdqPatchPTO
{
    isDens = 0,
    isLoad
 
}; // enum AdqPatchPTO
 
class CurtailmentSharing final
{
public:
    AdqPatchPTO priceTakingOrder;
    double thresholdRun;
    double thresholdDisplayViolations;
    int thresholdVarBoundsRelaxation;
    bool includeHurdleCost;
    bool checkCsrCostFunction;
 
    bool updateFromKeyValue(const Yuni::String& key, const Yuni::String& value);
    void addProperties(IniFile::Section* section) const;
 
    void reset();
 
private:
    void resetThresholds();
};
 
struct AdqPatchParams
{
    bool enabled;
    bool setToZeroOutsideInsideLinks = true;
 
    // TODO VP: remove this comment
    // This parameters does nothing right now, it will be implemented later in 9.3.x
    bool redispatch = false;
 
    CurtailmentSharing curtailmentSharing;
 
    void reset();
    void addExcludedVariables(std::vector<std::string>&) const;
    bool updateFromKeyValue(const Yuni::String& key, const Yuni::String& value);
    void saveToINI(IniFile& ini) const;
    bool checkAdqPatchParams(const SimulationMode simulationMode,
                             const AreaList& areas,
                             const bool includeHurdleCostParameters) const;
 
    void checkAdqPatchSimulationModeEconomyOnly(const SimulationMode simulationMode) const;
    void checkAdqPatchContainsAdqPatchArea(const Antares::Data::AreaList& areas) const;
    void checkAdqPatchIncludeHurdleCost(const bool includeHurdleCost) const;
};
 
} // namespace Antares::Data::AdequacyPatch