generation.h

Go to the documentation of this file.

/*
 * 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 <algorithm>
#include <string_view>
 
#include <antares/study/area/area.h>
 
#include "timeseries_base.h"
 
namespace Antares::Solver::Variable::Economy
{
 
 
struct SolarTag
{
};
 
struct WindTag
{
};
 
 
 
struct SolarTraits
{
    inline static constexpr std::string_view kCaption = "SOLAR";
    inline static constexpr std::string_view kDescription = "Solar generation, thoughout all MC "
                                                            "years";
    // Pointer-to-member for accessing solar data from Area
    static constexpr auto areaMember = &Data::Area::solar;
};
 
struct WindTraits
{
    inline static constexpr std::string_view kCaption = "WIND";
    inline static constexpr std::string_view kDescription = "Wind generation, thoughout all MC "
                                                            "years";
    // Pointer-to-member for accessing wind data from Area
    static constexpr auto areaMember = &Data::Area::wind;
};
 
 
 
using VCardTimeSeriesValuesSolar = VCardTimeSeriesBase<SolarTraits>;
 
using VCardTimeSeriesValuesWind = VCardTimeSeriesBase<WindTraits>;
 
 
 
template<class Tag>
struct GenerationTraits; // primary template (undefined)
 
template<>
struct GenerationTraits<SolarTag>: public SolarTraits
{
};
 
template<>
struct GenerationTraits<WindTag>: public WindTraits
{
};
 
template<class Tag>
using VCardTimeSeriesValuesGeneration = VCardTimeSeriesBase<GenerationTraits<Tag>>;
 
 
 
template<class TraitsType, class NextT = Container::EndOfList>
class TimeSeriesValuesGenerationImpl
    : public TimeSeriesValuesBase<TimeSeriesValuesGenerationImpl<TraitsType, NextT>,
                                  NextT,
                                  VCardTimeSeriesBase<TraitsType>>
{
public:
    using BaseType = TimeSeriesValuesBase<TimeSeriesValuesGenerationImpl<TraitsType, NextT>,
                                          NextT,
                                          VCardTimeSeriesBase<TraitsType>>;
    using VCardType = VCardTimeSeriesBase<TraitsType>;
 
 
    void initializeDerivedFromStudy(Data::Study& study)
    {
        isRenewableGenerationAggregated = study.parameters.renewableGeneration.isAggregated();
    }
 
    void yearBeginImpl(unsigned int year, unsigned int space)
    {
        if (isRenewableGenerationAggregated)
        {
            // Type-safe access to area data using traits
            auto& holder = (BaseType::areaPtr->*TraitsType::areaMember);
            // Bulk copy of time series data for performance
            std::copy_n(holder.series.getColumn(year),
                        holder.series.timeSeries.height,
                        BaseType::yearlyValues[space].hour);
        }
    }
 
    void hourForEachAreaImpl(State&, unsigned int)
    {
        // Default implementation - no specific action needed for generation
        // Values are already copied in yearBeginImpl for performance
    }
 
private:
 
    bool isRenewableGenerationAggregated{true};
};
 
 
 
template<class Tag, class NextT = Container::EndOfList>
using TimeSeriesValuesGeneration = TimeSeriesValuesGenerationImpl<GenerationTraits<Tag>, NextT>;
 
template<class NextT = Container::EndOfList>
using TimeSeriesValuesSolar = TimeSeriesValuesGenerationImpl<SolarTraits, NextT>;
 
template<class NextT = Container::EndOfList>
using TimeSeriesValuesWind = TimeSeriesValuesGenerationImpl<WindTraits, NextT>;
 
 
} // namespace Antares::Solver::Variable::Economy