loopFlow.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_ECONOMY_LoopFlow_H__
#define __SOLVER_VARIABLE_ECONOMY_LoopFlow_H__
 
#include "../../variable.h"
 
namespace Antares::Solver::Variable::Economy
{
struct VCardLoopFlow
{
    static std::string Caption()
    {
        return "LOOP FLOW";
    }
 
    static std::string Unit()
    {
        return "MWh";
    }
 
    static std::string Description()
    {
        return "Loop flow";
    }
 
    typedef Results<R::AllYears::Raw< // Raw values
      >>
      ResultsType;
 
    static constexpr uint8_t categoryDataLevel = Category::DataLevel::link;
    static constexpr uint8_t categoryFileLevel = ResultsType::categoryFile
                                                 & (Category::FileLevel::id
                                                    | Category::FileLevel::va);
    static constexpr uint8_t precision = Category::all;
    static constexpr uint8_t nodeDepthForGUI = +0;
    static constexpr uint8_t decimal = 0;
    static constexpr int columnCount = 1;
    static constexpr uint8_t spatialAggregate = Category::spatialAggregateSum;
    static constexpr uint8_t spatialAggregateMode = Category::spatialAggregateEachYear;
    static constexpr uint8_t spatialAggregatePostProcessing = 0;
    static constexpr uint8_t hasIntermediateValues = 1;
    static constexpr uint8_t isPossiblyNonApplicable = 0;
 
    typedef IntermediateValues IntermediateValuesType;
 
}; // class VCard
 
template<class NextT = Container::EndOfList>
class LoopFlow: public Variable::IVariable<LoopFlow<NextT>, NextT, VCardLoopFlow>
{
public:
    typedef NextT NextType;
    typedef VCardLoopFlow VCardType;
    typedef Variable::IVariable<LoopFlow<NextT>, NextT, VCardType> AncestorType;
 
    typedef typename VCardType::ResultsType ResultsType;
 
    typedef VariableAccessor<ResultsType, VCardType::columnCount> VariableAccessorType;
 
    enum
    {
        count = 1 + NextT::count,
    };
 
    template<int CDataLevel, int CFile>
    struct Statistics
    {
        enum
        {
            count = ((VCardType::categoryDataLevel & CDataLevel
                      && VCardType::categoryFileLevel & CFile)
                       ? (NextType::template Statistics<CDataLevel, CFile>::count
                          + VCardType::columnCount * ResultsType::count)
                       : NextType::template Statistics<CDataLevel, CFile>::count),
        };
    };
 
public:
    ~LoopFlow()
    {
    }
 
    void initializeFromStudy(Data::Study& study)
    {
        // Average on all years
        InitializeResultsFromStudy(AncestorType::pResults, study);
 
        // Intermediate values
        pValuesForTheCurrentYear.initializeFromStudy(study);
 
        // Next
        NextType::initializeFromStudy(study);
    }
 
    template<class R>
    static void InitializeResultsFromStudy(R& results, Data::Study& study)
    {
        VariableAccessorType::InitializeAndReset(results, study);
    }
 
    void initializeFromArea(Data::Study* study, Data::Area* area)
    {
        // Next
        NextType::initializeFromArea(study, area);
    }
 
    void initializeFromLink(Data::Study* study, Data::AreaLink* link)
    {
        // Next
        NextType::initializeFromAreaLink(study, link);
    }
 
    void initializeFromAreaLink(Data::Study* study, Data::AreaLink* link)
    {
        if (link->useLoopFlow)
        {
            // Flow assessed over all MC years (linear)
            unsigned int height = link->parameters.height;
            (void)::memcpy(pValuesForTheCurrentYear.hour,
                           link->parameters[Data::fhlLoopFlow],
                           sizeof(double) * height);
        }
 
        // Next
        NextType::initializeFromAreaLink(study, link);
    }
 
    void simulationBegin()
    {
        // Next
        NextType::simulationBegin();
    }
 
    void simulationEnd()
    {
        // Compute all statistics for the current year (daily,weekly,monthly)
        pValuesForTheCurrentYear.computeStatisticsForTheCurrentYear();
        // Merge all those values with the global results
        AncestorType::pResults.merge(0, pValuesForTheCurrentYear);
 
        // Next
        NextType::simulationEnd();
    }
 
    void yearBegin(uint year, unsigned int numSpace)
    {
        // Next variable
        NextType::yearBegin(year, numSpace);
    }
 
    void yearEndBuild(State& state, unsigned int year, unsigned int numSpace)
    {
        // Next variable
        NextType::yearEndBuild(state, year, numSpace);
    }
 
    void yearEnd(uint year, unsigned int numSpace)
    {
        // Next variable
        NextType::yearEnd(year, numSpace);
    }
 
    void computeSummary(unsigned int year, unsigned int numSpace)
    {
        // Next variable
        NextType::computeSummary(year, numSpace);
    }
 
    void hourBegin(uint hourInTheYear)
    {
        // Next variable
        NextType::hourBegin(hourInTheYear);
    }
 
    void hourForEachArea(State& state, unsigned int numSpace)
    {
        // Next variable
        NextType::hourForEachArea(state, numSpace);
    }
 
    void hourForEachLink(State& state, unsigned int numSpace)
    {
        // Next item in the list
        NextType::hourForEachLink(state, numSpace);
    }
 
    void buildDigest(SurveyResults& results, int digestLevel, int dataLevel) const
    {
        // Next
        NextType::buildDigest(results, digestLevel, dataLevel);
    }
 
    Antares::Memory::Stored<double>::ConstReturnType retrieveRawHourlyValuesForCurrentYear(
      uint,
      uint) const
    {
        return pValuesForTheCurrentYear.hour;
    }
 
    void localBuildAnnualSurveyReport(SurveyResults& results,
                                      int fileLevel,
                                      int precision,
                                      uint) const
    {
        // Initializing external pointer on current variable non applicable status
        results.isCurrentVarNA = AncestorType::isNonApplicable;
 
        if (AncestorType::isPrinted[0])
        {
            // Write the data for the current year
            results.variableCaption = VCardType::Caption();
            results.variableUnit = VCardType::Unit();
            pValuesForTheCurrentYear.template buildAnnualSurveyReport<VCardType>(results,
                                                                                 fileLevel,
                                                                                 precision);
        }
    }
 
private:
    typename VCardType::IntermediateValuesType pValuesForTheCurrentYear;
 
}; // class LoopFlow
 
} // namespace Antares::Solver::Variable::Economy
 
#endif // __SOLVER_VARIABLE_ECONOMY_LoopFlow_H__