intermediate.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_VARIABLE_STORAGE_INTERMEDIATE_H__
#define __SOLVER_VARIABLE_STORAGE_INTERMEDIATE_H__
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
 
#include <antares/study/study.h>
#include "antares/antares/constants.h"
 
#include "../categories.h"
#include "../surveyresults.h"
 
namespace Antares::Solver::Variable
{
class IntermediateValues final
{
public:
    typedef double Type;
 
public:
 
 
    IntermediateValues();
    ~IntermediateValues();
 
    void initializeFromStudy(Data::Study& study);
 
    void reset();
 
    void computeStatisticsForTheCurrentYear();
 
    void computeStatisticsOrForTheCurrentYear();
 
    void computeStatisticsAdequacyForTheCurrentYear();
 
    // Compute averages for the current year from a particular time division results :
    // For instances :
    // - compute averages daily to yearly, from hourly results
    // - compute averages monthly to yearly, from weekly results
    void computeAveragesForCurrentYearFromHourlyResults();
    void computeAveragesForCurrentYearFromDailyResults();
    void computeAveragesForCurrentYearFromWeeklyResults();
 
    void computeProbabilitiesForTheCurrentYear();
 
    void adjustValuesWhenRelatedToAPrice();
 
    void adjustValuesAdequacyWhenRelatedToAPrice();
 
 
    template<class VCardT>
    void buildAnnualSurveyReport(SurveyResults& report, int fileLevel, int precision) const;
 
 
 
    Type& operator[](const uint index);
    const Type& operator[](const uint index) const;
 
    Antares::Data::StudyRangeLimits* pRange;
    Antares::Date::Calendar* calendar;
    Antares::Data::StudyRuntimeInfos* pRuntimeInfo;
 
    Type month[MONTHS_PER_YEAR];
    Type week[WEEKS_PER_YEAR];
    Type day[DAYS_PER_YEAR];
    mutable Antares::Memory::Stored<Type>::Type hour;
    Type year;
 
    template<uint Size, class VCardT, class A>
    void internalExportAnnualValues(SurveyResults& report, const A& array, bool annual) const;
 
    void computeDailyAveragesForCurrentYear();
    void computeWeeklyAveragesForCurrentYear();
    void computeMonthlyAveragesForCurrentYear();
    void computeYearlyAveragesForCurrentYear();
 
}; // class IntermediateValues
 
} // namespace Antares::Solver::Variable
 
#include "intermediate.hxx"
 
#endif // __SOLVER_VARIABLE_STORAGE_INTERMEDIATE_H__