area.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 __ANTARES_LIBS_STUDY_AREAS_H__
#define __ANTARES_LIBS_STUDY_AREAS_H__
 
#include <filesystem>
#include <set>
#include <stdlib.h>
#include <vector>
//
#include "antares/study/parts/parts.h"
//
#include <yuni/yuni.h>
#include <yuni/core/noncopyable.h>
#include <yuni/core/string.h>
 
#include <antares/array/matrix.h>
#include <antares/study/parameters/adq-patch-params.h>
#include "antares/study/filter.h"
 
#include "constants.h"
#include "links.h"
#include "ui.h"
 
namespace Antares::Data
{
struct CompareAreaName;
 
class Area final: private Yuni::NonCopyable<Area>
{
public:
    using NameSet = std::set<AreaName>;
    using Set = std::set<Area*, CompareAreaName>;
    using LinkMap = std::map<Area*, AreaLink::Set, CompareAreaName>;
    using Map = std::map<AreaName, Area*>;
    using Vector = std::vector<Area*>;
    using VectorConst = std::vector<const Area*>;
    using List = std::list<Area*>;
    using ScratchMap = std::map<const Area*, AreaScratchpad&>;
    using NameMapping = std::map<AreaName, AreaName>;
 
public:
 
 
    Area();
    explicit Area(const AnyString& name);
    Area(const AnyString& name, const AnyString& id);
    ~Area();
 
 
    // !\name isVisibleOnLayer
 
    bool isVisibleOnLayer(const size_t& layerID) const
    {
        if (ui == nullptr)
        {
            return false;
        }
 
        std::vector<size_t>& layerList = ui->mapLayersVisibilityList;
        std::vector<size_t>::iterator layerPosition = std::find(layerList.begin(),
                                                                layerList.end(),
                                                                layerID);
        return layerPosition != layerList.end();
    }
 
 
 
    void clearAllLinks();
 
    void detachAllLinks();
 
    AreaLink* findLinkByID(const AreaName& id);
    const AreaLink* findLinkByID(const AreaName& id) const;
 
    void detachLinkFromID(const AreaName& id);
 
    static void detachLink(const AreaLink* lnk);
 
    void detachLinkFromItsPointer(const AreaLink* lnk);
 
    void buildLinksIndexes();
    void createMissingData();
 
    void resetToDefaultValues();
 
    void resizeAllTimeseriesNumbers(uint nbYears);
 
    AreaLink* findExistingLinkWith(Area& with);
    const AreaLink* findExistingLinkWith(const Area& with) const;
 
 
 
    bool forceReload(bool reload = false) const;
 
    void markAsModified() const;
 
 
 
    bool thermalClustersMinStablePowerValidity(std::vector<YString>& output) const;
 
    template<enum TimeSeriesType T>
    XCast* xcastData();
    template<enum TimeSeriesType T>
    const XCast* xcastData() const;
 
public:
 
    AreaName name;
    AreaName id;
    uint index = (uint)(-1);
    AdequacyPatch::AdequacyPatchMode adequacyPatchMode = AdequacyPatch::physicalAreaOutsideAdqPatch;
 
 
    Matrix<> reserves;
    Matrix<> miscGen; // [fhhMax][HOURS_PER_YEAR]
 
 
    Load::Container load;
 
 
    Solar::Container solar;
 
 
    PartHydro hydro;
 
 
    Wind::Container wind;
 
 
    PartThermal thermal;
 
 
    PartRenewable renewable;
 
    ShortTermStorage::STStorageInput shortTermStorage;
 
 
    AreaLink::Map links;
 
 
    uint nodalOptimization = anoAll;
 
 
    double spreadUnsuppliedEnergyCost = 0.;
    double spreadSpilledEnergyCost = 0.;
 
 
    uint filterSynthesis = filterAll;
    uint filterYearByYear = filterAll;
 
 
    std::unique_ptr<AreaUI> ui;
 
 
 
    mutable std::vector<AreaScratchpad> scratchpad;
 
 
 
    mutable bool invalidateJIT = false;
 
private:
    void internalInitialize();
    void createMissingTimeSeries();
    void createMissingPrepros();
 
}; // class Area
 
bool saveAreaOptimisationIniFile(const Area& area, const Yuni::Clob& buffer);
 
bool saveAreaAdequacyPatchIniFile(const Area& area, const Yuni::Clob& buffer);
 
class AreaList final: public Yuni::NonCopyable<AreaList>
{
public:
    using iterator = Area::Map::iterator;
    using const_iterator = Area::Map::const_iterator;
    using reverse_iterator = Area::Map::reverse_iterator;
    using const_reverse_iterator = Area::Map::const_reverse_iterator;
    using value_type = Area::Map::value_type;
 
public:
 
 
    explicit AreaList(Study& study);
    ~AreaList();
 
 
 
    template<class PredicateT>
    void each(const PredicateT& predicate);
    template<class PredicateT>
    void each(const PredicateT& predicate) const;
 
    iterator begin();
    const_iterator begin() const;
    const_iterator cbegin() const;
 
    iterator end();
    const_iterator end() const;
    const_iterator cend() const;
 
    reverse_iterator rbegin();
    const_reverse_iterator rbegin() const;
 
    reverse_iterator rend();
    const_reverse_iterator rend() const;
 
 
 
    void ensureDataIsInitialized(Parameters& params, bool loadOnlyNeeded);
 
 
 
    bool loadFromFolder(const StudyLoadOptions& options);
 
    bool loadListFromFile(const std::filesystem::path& filename);
 
#ifdef BUILD_UI
    bool saveToFolder(const AnyString& folder) const;
 
    bool saveListToFile(const AnyString& filename) const;
#endif
 
    void saveLinkListToBuffer(Yuni::Clob& buffer) const;
 
    bool preloadAndMarkAsModifiedAllInvalidatedAreas(uint* invalidateCount = nullptr) const;
 
 
 
    Area* add(Area* a);
 
    Area* find(const AreaName& id);
    const Area* find(const AreaName& id) const;
 
    Area* findFromName(const AreaName& name);
 
    Area* findFromPosition(const int x, const int y) const;
 
    const Area* findFromName(const AreaName& name) const;
 
    void resizeAllTimeseriesNumbers(uint n);
 
    void clear();
 
    bool empty() const;
 
    bool forceReload(bool reload = false) const;
 
    void markAsModified() const;
 
    void rebuildIndexes();
 
    bool remove(const AnyString& id);
 
    bool renameArea(const AreaName& oldid, const AreaName& newName);
 
    bool renameArea(const AreaName& oldid, const AreaName& newid, const AreaName& newName);
 
    uint size() const;
 
 
 
    AreaLink* findLink(const AreaName& area, const AreaName& with);
    const AreaLink* findLink(const AreaName& area, const AreaName& with) const;
 
    AreaLink* findLinkFromINIKey(const AnyString& key);
 
    ThermalCluster* findClusterFromINIKey(const AnyString& key);
 
    uint areaLinkCount() const;
 
 
 
    void fixOrientationForAllInterconnections(BindingConstraintsRepository& bindingconstraints);
 
    void removeLoadTimeseries();
    void removeHydroTimeseries();
    void removeSolarTimeseries();
    void removeWindTimeseries();
    void removeThermalTimeseries();
 
    Area::ScratchMap buildScratchMap(uint numspace);
 
    void updateNameIDSet() const;
 
 
 
    Area* operator[](uint i);
    const Area* operator[](uint i) const;
 
public:
    std::vector<Area*> byIndex;
    Area::Map areas;
 
    // used by the copy/paste
    mutable Area::NameSet nameidSet;
 
private:
    Study& pStudy;
 
}; // class AreaList
 
void AreaListDeleteLinkFromAreaPtr(AreaList* l, const Area* a);
 
AreaLink* AreaAddLinkBetweenAreas(Area* area, Area* with, bool warning = true);
 
bool AreaLinksLoadFromFolder(Study& s,
                             AreaList* l,
                             Area* area,
                             const std::filesystem::path& folder);
 
#ifdef BUILD_UI
bool AreaLinksSaveToFolder(const Area* area, const char* const folder);
 
// Save a given area's interconnexions configuration file into a folder
bool saveAreaLinksConfigurationFileToFolder(const Area* area, const char* const folder);
#endif
 
int AreaLinkClear(AreaList* l, Area* area);
 
void AreaLinkRemove(AreaLink* lnk);
 
Area* AreaListLFind(AreaList* l, const char lname[]);
 
Area* AreaListFindPtr(AreaList* l, const Area* ptr);
 
Area* addAreaToListOfAreas(AreaList& list, const AnyString& name);
 
Area* AreaListAddFromNames(AreaList& list, const AnyString& name, const AnyString& lname);
 
AreaLink* AreaListAddLink(AreaList* l, const char area[], const char with[], bool warning = true);
 
void AreaListClearAllLinks(AreaList* l);
 
void AreaListEnsureDataLoadPrepro(AreaList* l);
 
void AreaListEnsureDataSolarPrepro(AreaList* l);
 
void AreaListEnsureDataWindPrepro(AreaList* l);
 
void AreaListEnsureDataHydroTimeSeries(AreaList* l);
 
void AreaListEnsureDataHydroPrepro(AreaList* l);
 
void AreaListEnsureDataThermalPrepro(AreaList* l);
 
inline bool CheckForbiddenCharacterInAreaName(const AnyString& name)
{
    return name.contains('*');
}
 
} // namespace Antares::Data
 
#include "../load-options.h"
#include "area.hxx"
 
#endif // __ANTARES_LIBS_STUDY_AREAS_H__