common-eco-adq.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/>.
 */
#ifndef __SOLVER_SIMULATION_COMMON_ECONOMY_ADEQUACY_H__
#define __SOLVER_SIMULATION_COMMON_ECONOMY_ADEQUACY_H__
 
#include <vector>
 
#include <antares/study/study.h>
#include "antares/solver/optimisation/opt_fonctions.h"
#include "antares/solver/simulation/random.h"
#include "antares/solver/simulation/solver.h" // for definition of type yearRandomNumbers
#include "antares/solver/variable/economy/all.h"
#include "antares/solver/variable/economy/dispatchable-generation-margin.h" // for OP.MRG
#include "antares/solver/variable/variable.h"
 
namespace Antares::Solver::Simulation
{
// We use the namespace 'economy' here. That means it is mandatory
// that adequacy has the same variable (to get the same type)
typedef Solver::Variable::Economy::VCardBalance AvgExchangeVCardBalance;
typedef Variable::Storage<AvgExchangeVCardBalance>::ResultsType AvgExchangeResults;
 
void PrepareRandomNumbers(Data::Study& study,
                          PROBLEME_HEBDO& problem,
                          yearRandomNumbers& randomForYear);
 
void SetInitialHydroLevel(Data::Study& study,
                          PROBLEME_HEBDO& problem,
                          const HYDRO_VENTILATION_RESULTS& hydroVentilationResults);
 
void BuildThermalPartOfWeeklyProblem(Data::Study& study,
                                     PROBLEME_HEBDO& problem,
                                     const int PasDeTempsDebut,
                                     const std::vector<std::vector<double>>& thermalNoises,
                                     unsigned int year);
 
bool ShouldUseQuadraticOptimisation(const Data::Study& study);
 
void ComputeFlowQuad(Data::Study& study,
                     PROBLEME_HEBDO& problem,
                     const std::vector<AvgExchangeResults*>& balance,
                     unsigned int nbWeeks);
 
void RemixHydroForAllAreas(const Data::AreaList& areas,
                           PROBLEME_HEBDO& problem,
                           const Data::Parameters& params,
                           uint numSpace,
                           uint hourInYear,
                           IResultWriter& resultWriter);
 
/*
** \brief Interpolates water values related to reservoir levels for outputs only
**
** \param areas : the areas of study
** \param problem The weekly problem, from the solver
*point of weekly simulation)
** \param hourInYear The hour in the year of the first hour in the current week
**
** For any hour, the computed water values are related to the beginning of the hour, not the end.
*/
void interpolateWaterValue(const Data::AreaList& areas,
                           PROBLEME_HEBDO& problem,
                           const Date::Calendar& calendar,
                           int hourInTheYear);
 
/*
** \brief Updating the weekly simulation final reservoir level, to be used as a start for the next
*week.
**
** \param areas : the areas of study
** \param problem The weekly problem, from the solver
*/
void updatingWeeklyFinalHydroLevel(const Data::AreaList& areas, PROBLEME_HEBDO& problem);
 
/*
** \brief Compute the weighted average NTC for a link
**
** \param areas : the areas of study
** \param link The link
** \param Weighted average NTC for the direct direction
** \param Weighted average NTC for the indirect direction
*/
int retrieveAverageNTC(const Data::Study& study,
                       const Matrix<>& capacities,
                       const Data::TimeSeriesNumbers& tsNumbers,
                       std::vector<double>& avg);
 
void finalizeOptimizationStatistics(PROBLEME_HEBDO& problem,
                                    Antares::Solver::Variable::State& state);
 
void prepareClustersInMustRunMode(Data::Study& study,
                                  Data::Area::ScratchMap& scratchmap,
                                  uint year,
                                  Data::SimulationMode mode);
 
} // namespace Antares::Solver::Simulation
 
#endif // __SOLVER_SIMULATION_COMMON_ECONOMY_ADEQUACY_H__