cluster_list.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/>.
 */
#pragma once
 
#include <filesystem>
#include <functional>
 
#include "../common/cluster_list.h"
#include "cluster.h"
 
namespace Antares::Data
{
class ThermalClusterList final: public ClusterList<ThermalCluster>
{
public:
    std::string typeID() const override;
 
    bool loadFromFolder(Study& s, const std::filesystem::path& folder, Area* area);
 
 
 
    ThermalClusterList();
    virtual ~ThermalClusterList();
 
 
 
    void calculationOfSpinning();
 
    void reverseCalculationOfSpinning();
 
 
 
    void enableMustrunForEveryone();
 
 
    auto each_mustrun_and_enabled() const
    {
        return allClusters_ | std::views::filter(&ThermalCluster::isMustRun)
               | std::views::filter(&ThermalCluster::isEnabled);
    }
 
    auto each_enabled_and_not_mustrun() const
    {
        return allClusters_ | std::views::filter(&ThermalCluster::isEnabled)
               | std::views::filter(std::not_fn(&ThermalCluster::isMustRun));
    }
 
    void ensureDataPrepro();
 
    bool loadPreproFromFolder(Study& s, const std::filesystem::path& folder);
    bool validatePrepro(const Study& study);
 
    bool validateClusters(const Parameters& param) const;
 
    bool loadEconomicCosts(Study& s, const std::filesystem::path& folder);
 
    bool savePreproToFolder(const AnyString& folder) const;
    bool saveEconomicCosts(const AnyString& folder) const;
 
#ifdef BUILD_UI
    bool saveToFolder(const AnyString& folder) const override;
#endif
 
    unsigned int enabledAndMustRunCount() const;
    unsigned int enabledAndNotMustRunCount() const;
 
private:
    // Give a special index to enbled and not must-run THERMAL clusters
    void rebuildIndex() const;
 
}; // class ThermalClusterList
} // namespace Antares::Data