variable.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_VARIABLE_H__
#define __SOLVER_VARIABLE_VARIABLE_H__
 
// Remove the visual studio warning: decorated name length exceeded, name was truncated
#ifdef YUNI_OS_MSVC
#pragma warning(disable : 4503)
#endif
 
#include <yuni/yuni.h>
#include <yuni/core/static/if.h>
 
#include "categories.h"
#include "container.h"
#include "endoflist.h"
#include "info.h"
#include "storage/intermediate.h"
#include "storage/results.h"
#include "surveyresults.h"
 
namespace Antares::Solver::Variable
{
template<class ChildT, class NextT, class VCardT>
class IVariable: protected NextT
{
public:
    typedef ChildT ChildType;
    typedef NextT NextType;
    typedef IVariable<ChildT, NextT, VCardT> VariableType;
    typedef VCardT VCardType;
    typedef typename VCardType::ResultsType ResultsType;
    typedef VariableAccessor<ResultsType, VCardType::columnCount> VariableAccessorType;
    typedef typename Storage<VCardT>::ResultsType StoredResultType;
 
    static constexpr uint8_t categoryDataLevel = VCardType::categoryDataLevel;
    static constexpr uint8_t categoryFileLevel = VCardType::categoryFileLevel;
 
    template<int CDataLevel, int CFile>
    struct Statistics
    {
        enum
        {
            count = ((categoryDataLevel & CDataLevel && categoryFileLevel & CFile)
                       ? (NextType::template Statistics<CDataLevel, CFile>::count
                          + ResultsType::count)
                       : NextType::template Statistics<CDataLevel, CFile>::count),
        };
    };
 
public:
    template<class R>
    static void InitializeResultsFromStudy(R& results, Data::Study& study);
 
    template<class PredicateT>
    static void RetrieveVariableList(PredicateT& predicate);
 
    void getPrintStatusFromStudy(Data::Study& study);
    void supplyMaxNumberOfColumns(Data::Study& study);
 
public:
 
 
    IVariable();
 
    ~IVariable();
 
 
 
    void initializeFromStudy(Data::Study& study);
 
    size_t getMaxNumberColumns() const;
 
    void initializeFromArea(Data::Study* study, Data::Area* area);
 
    void initializeFromLink(Data::Study* study, Data::AreaLink* link);
 
    void initializeFromThermalCluster(Data::Study* study,
                                      Data::Area* area,
                                      Data::ThermalCluster* cluster);
 
    void broadcastNonApplicability(bool applyNonApplicable);
 
 
 
    void simulationBegin();
 
    void simulationEnd();
 
 
 
    void yearBegin(uint year);
 
    void yearEndBuild(State& state, uint year);
 
    void yearEndBuildPrepareDataForEachThermalCluster(State& state, uint year, uint numSpace);
 
    void yearEndBuildForEachThermalCluster(State& state, uint year, uint numSpace);
 
    void yearEnd(uint year);
 
    template<class V>
    void yearEndSpatialAggregates(V& allVars, uint year, unsigned int numSpace);
 
    template<class V, class SetT>
    void yearEndSpatialAggregates(V& allVars, uint year, const SetT& set);
 
    template<class V>
    void simulationEndSpatialAggregates(V& allVars);
 
    template<class V, class SetT>
    void simulationEndSpatialAggregates(V& allVars, const SetT& set);
 
 
    void hourBegin(uint hourInTheYear);
    void hourForEachArea(State& state);
 
    void hourForEachArea(State& state, unsigned int numSpace);
 
    // for a given area
    void hourForEachLink(State& state, uint numSpace);
    void hourEnd(State& state, uint hourInTheYear);
 
 
    void weekBegin(State& state);
    void weekForEachArea(State& state, uint numSpace);
 
    void weekEnd(State& state);
 
 
    void buildSurveyReport(SurveyResults& results,
                           int dataLevel,
                           int fileLevel,
                           int precision) const;
 
    void buildAnnualSurveyReport(SurveyResults& results,
                                 int dataLevel,
                                 int fileLevel,
                                 int precision,
                                 uint numSpace) const;
 
    void buildDigest(SurveyResults& results, int digestLevel, int dataLevel) const;
 
    void beforeYearByYearExport(uint year, uint numSpace);
 
    template<class I>
    static void provideInformations(I& infos);
 
    template<class VCardSearchT, class O>
    void computeSpatialAggregateWith(O& out, uint numSpace);
 
    template<class VCardSearchT, class O>
    void computeSpatialAggregateWith(O& out, const Data::Area* area);
 
    template<class VCardToFindT>
    const double* retrieveHourlyResultsForCurrentYear(uint numSpace) const;
 
    template<class VCardToFindT>
    void retrieveResultsForArea(typename Storage<VCardToFindT>::ResultsType** result,
                                const Data::Area* area);
 
    template<class VCardToFindT>
    void retrieveResultsForThermalCluster(typename Storage<VCardToFindT>::ResultsType** result,
                                          const Data::ThermalCluster* cluster);
 
    template<class VCardToFindT>
    void retrieveResultsForLink(typename Storage<VCardToFindT>::ResultsType** result,
                                const Data::AreaLink* link);
 
    Antares::Memory::Stored<double>::ConstReturnType retrieveRawHourlyValuesForCurrentYear(
      uint column,
      uint) const;
 
    const StoredResultType& results() const;
 
protected:
    StoredResultType pResults;
    // Does current output variable appears non applicable in all output files.
    // Following is an array of size :
    // + 1 if variable is a single variable
    // + > 1 if variable is a multi-variable
    bool* isNonApplicable;
    // Do we print results regarding the current variable in output files ? Or do we skip them ?
    bool* isPrinted;
    // Positive column count (original column count can be < 0 for some variable [see variables "by
    // plant"])
    uint pColumnCount;
 
}; // class Variable
 
} // namespace Antares::Solver::Variable
 
#include "variable.hxx"
 
#endif // __SOLVER_VARIABLE_VARIABLE_H__