Multiple Maximum Generation and Pumping for Hydro (Refactoring)

docs/reference-guide/03-commands.md

@@ -178,7 +178,7 @@ this command allows to state, for each kind of time-series, whether it should be
 the available set (be it ready-made or Antares-generated) _**OR**_ should take a user-defined value
 (in the former case, the default "rand" value should be kept; in the latter, the value should be the reference number of the time-series to use). Multiple simulation profiles can be defined and archived. The default active profile gives the "rand" status for all time-series in all areas (full probabilistic simulation).
 
-  Regarding Hydro time-series, the scenario builder gives, in addition to the assignment of a specific number to use for the inflows time-series, the ability to define the initial reservoir level to use for each MC year, also hydro power credits scenario builder is available to support time-series for Maximum Generation and Maximum Pumping because the number of TS's for ROR, Hydro Storage and Minimum Generation can be different than the  number of TS's for Maximum Generation and Maximum Pumping.
+  Regarding Hydro time-series, the scenario builder gives, in addition to the assignment of a specific number to use for the inflows time-series, the ability to define the initial reservoir level to use for each MC year, also hydro max power scenario builder is available to support time-series for Maximum Generation and Maximum Pumping because the number of TS's for ROR, Hydro Storage and Minimum Generation can be different than the  number of TS's for Maximum Generation and Maximum Pumping.
 
 - **MC Scenario playlist** For each Monte-Carlo year of the simulation defined in the "Simulation" active window,
 this command allows to state whether a MC year prepared for the simulation should be actually simulated or not.

docs/reference-guide/04-active_windows.md

@@ -97,10 +97,10 @@ These two parts are detailed hereafter.
 
 ### RIGHT PART: Time-series management
 
-For the different kinds of time-series that Antares manages in a non-deterministic way (load, thermal generation, hydro power, hydro power credits, wind power, solar power or renewable depending on the option chosen):
+For the different kinds of time-series that Antares manages in a non-deterministic way (load, thermal generation, hydro power, hydro max power, wind power, solar power or renewable depending on the option chosen):
 
 1. **Choice of the kind of time-series to use**
-Either « ready-made » or «stochastic » (i.e. Antares-generated), defined by setting the value to either "on" or "off". Exception is hydro power credits that can only be « ready-made ». Note that for Thermal time-series, the cluster-wise parameter may overrule this global parameter (see Thermal window description below).
+Either « ready-made » or «stochastic » (i.e. Antares-generated), defined by setting the value to either "on" or "off". Exception is hydro max power that can only be « ready-made ». Note that for Thermal time-series, the cluster-wise parameter may overrule this global parameter (see Thermal window description below).
 
 2. **For stochastic TS only**:
     - **Number** Number of TS to generate

docs/reference-guide/13-file-format.md

@@ -1,11 +1,11 @@
 # Study format changes
 This is a list of all recent changes that came with new Antares Simulator features. The main goal of this document is to lower the costs of changing existing interfaces, both GUI and scripts.
 ## v8.8.0
-For each area, new files are added **input/hydro/series/<area>/maxgen.txt** and **input/hydro/series/<area>/maxpump.txt**. These files have one or more columns, and 8760 rows. The number of columns in these two files must be the same, if there is more than one column in each file, but if there is just one column for example in maxgen.txt file, maxpump.txt file can have more than one column and vice versa. For old studies, file **input/hydro/common/capacity/maxpower_<area>** will be deleted after upgrading the study and corresponding data from that file will be copied to already mentioned new files, even if study is upgraded or not. In that case maxgen.txt and maxpump.txt files will have just one column and 8760 rows.
+For each area, new files are added **input/hydro/series/<area>/maxHourlyGenPower.txt** and **input/hydro/series/<area>/maxHourlyPumpPower.txt**. These files have one or more columns, and 8760 rows. The number of columns in these two files must be the same, if there is more than one column in each file, but if there is just one column for example in maxHourlyGenPower.txt file, maxHourlyPumpPower.txt file can have more than one column and vice versa. For old studies, file **input/hydro/common/capacity/maxpower_<area>** will be deleted after upgrading the study and corresponding data from that file will be copied to already mentioned new files, even if study is upgraded or not. In that case maxHourlyGenPower.txt and maxHourlyPumpPower.txt files will have just one column and 8760 rows.
 
-Also for each area, new files are added **input/hydro/common/capacity/maxhoursGen_<area>** and **input/hydro/common/capacity/maxhoursPump_<area>**. These files have just one column and 365 rows. For old studies, file **input/hydro/common/capacity/maxpower_<area>** will be deleted after upgrading the study and corresponding data from that file will be copied to already mentioned new files, even if study is upgraded or not.
+Also for each area, new files are added **input/hydro/common/capacity/maxDailyGenEnergy_<area>** and **input/hydro/common/capacity/maxDailyPumpEnergy_<area>**. These files have just one column and 365 rows. For old studies, file **input/hydro/common/capacity/maxpower_<area>** will be deleted after upgrading the study and corresponding data from that file will be copied to already mentioned new files, even if study is upgraded or not.
 ### Input
-Under `Configure/MC Scenario Builder` new section added `Hydro-Power-Credits`
+Under `Configure/MC Scenario Builder` new section added `Hydro Max Power`
 In the existing file **settings/scenariobuilder.dat**, under **<ruleset>** section following properties added:
 * **hgp,<area>,<year> = <hgp-value>**
 ## v8.7.0

src/libs/antares/study/CMakeLists.txt

@@ -23,8 +23,8 @@ set(SRC_STUDY_SCENARIO_BUILDER
         scenario-builder/ThermalTSNumberData.h
         scenario-builder/HydroTSNumberData.h
         scenario-builder/HydroTSNumberData.cpp
-        scenario-builder/HydroPowerCreditsTSNumberData.h
-        scenario-builder/HydroPowerCreditsTSNumberData.cpp
+        scenario-builder/HydroMaxPowerTSNumberData.h
+        scenario-builder/HydroMaxPowerTSNumberData.cpp
         scenario-builder/SolarTSNumberData.cpp
         scenario-builder/solarTSNumberData.h
         scenario-builder/WindTSNumberData.h
@@ -137,8 +137,8 @@ set(SRC_STUDY_PART_HYDRO
         parts/hydro/allocation.h
         parts/hydro/allocation.hxx
         parts/hydro/allocation.cpp
-        parts/hydro/datatransfer.h
-        parts/hydro/datatransfer.cpp
+        parts/hydro/hydromaxtimeseriesreader.h
+        parts/hydro/hydromaxtimeseriesreader.cpp
 )
 source_group("study\\part\\hydro" FILES ${SRC_STUDY_PART_HYDRO})
 

src/libs/antares/study/area/area.cpp

@@ -280,7 +280,7 @@ void Area::resizeAllTimeseriesNumbers(uint n)
         solar.series->timeseriesNumbers.clear();
         wind.series->timeseriesNumbers.clear();
         hydro.series->timeseriesNumbers.clear();
-        hydro.series->timeseriesNumbersPowerCredits.clear();
+        hydro.series->timeseriesNumbersHydroMaxPower.clear();
         for (auto& namedLink : links)
         {
             AreaLink* link = namedLink.second;
@@ -293,7 +293,7 @@ void Area::resizeAllTimeseriesNumbers(uint n)
         solar.series->timeseriesNumbers.resize(1, n);
         wind.series->timeseriesNumbers.resize(1, n);
         hydro.series->timeseriesNumbers.resize(1, n);
-        hydro.series->timeseriesNumbersPowerCredits.resize(1, n);
+        hydro.series->timeseriesNumbersHydroMaxPower.resize(1, n);
         for (auto& namedLink : links)
         {
             AreaLink* link = namedLink.second;

src/libs/antares/study/area/list.cpp

@@ -909,26 +909,31 @@ static bool AreaListLoadFromFolderSingleArea(Study& study,
 
         if (area.hydro.series && study.header.version < 870)
         {
-            std::shared_ptr<DataTransfer> datatransfer = std::make_shared<DataTransfer>();
             buffer.clear() << study.folderInput << SEP << "hydro";
 
-            datatransfer->LoadFromFolder(study, buffer, area);
-            datatransfer->SupportForOldStudies(study, buffer, area);
+            HydroMaxTimeSeriesReader reader;
+            ret = reader(buffer, area) && ret;
         }
 
-        if (area.hydro.series)
+        if (area.hydro.series && study.header.version >= 870)
         {
             buffer.clear() << study.folderInput << SEP << "hydro" << SEP << "series";
-            ret = area.hydro.series->LoadHydroPowerCredits(study, area.id, buffer) && ret;
+            ret = area.hydro.series->LoadMaxPower(area.id, buffer) && ret;
+
+            if (study.usedByTheSolver)
+            {
+                area.hydro.series->setCountVariable();
+                ret = area.hydro.series->postProcessMaxPowerTS(area) && ret;
+                area.hydro.series->setMaxPowerTSWhenDeratedMode(study);
+            }
+            else
+                area.hydro.series->setHydroModulability(study, area.id);
         }
 
         buffer.clear() << study.folderInput << SEP << "hydro" << SEP << "common" << SEP
-                       << "capacity" << SEP << "maxpower_" << area.id << '.'
-                       << study.inputExtension;
-
-        bool exists = IO::File::Exists(buffer);
+                       << "capacity" << SEP << "maxpower_" << area.id << ".txt";
 
-        if (study.header.version >= 870 && exists)
+        if (bool exists = IO::File::Exists(buffer); study.header.version >= 870 && exists)
         {
             IO::File::Delete(buffer);
         }
@@ -1639,8 +1644,8 @@ void AreaList::removeHydroTimeseries()
         area.hydro.series->ror.reset(1, HOURS_PER_YEAR);
         area.hydro.series->storage.reset(1, DAYS_PER_YEAR);
         area.hydro.series->mingen.reset(1, HOURS_PER_YEAR);
-        area.hydro.series->maxgen.reset(1, HOURS_PER_YEAR);
-        area.hydro.series->maxpump.reset(1, HOURS_PER_YEAR);
+        area.hydro.series->maxHourlyGenPower.reset(1, HOURS_PER_YEAR);
+        area.hydro.series->maxHourlyPumpPower.reset(1, HOURS_PER_YEAR);
         area.hydro.series->count = 1;
         area.hydro.series->countpowercredits = 1;
     });

src/libs/antares/study/area/scratchpad.cpp

@@ -88,10 +88,10 @@ AreaScratchpad::AreaScratchpad(const StudyRuntimeInfos& rinfos, Area& area) : ts
      bool hydroGenerationPermission = false;
 
     // ... Getting hydro max power
-    auto const& maxPower = area.hydro.series->maxgen;
-    auto const& maxGenHours = area.hydro.maxHoursGen[0];
+    auto const& maxHourlyGenPower = area.hydro.series->maxHourlyGenPower;
+    auto const& maxDailyGenEnergy = area.hydro.maxDailyGenEnergy[0];
 
-    hydroGenerationPermission = CheckForPositiveEnergy(maxPower, maxGenHours);
+    hydroGenerationPermission = CheckForPositiveEnergy(maxHourlyGenPower, maxDailyGenEnergy);
 
     // ---------------------
     // Hydro has inflows
@@ -127,11 +127,11 @@ AreaScratchpad::AreaScratchpad(const StudyRuntimeInfos& rinfos, Area& area) : ts
     // ... Hydro max power
 
     // ... Hydro max pumping power and energy
-     auto const& maxPumpingP = area.hydro.series->maxpump;
-     auto const& maxPumpHours = area.hydro.maxHoursPump[0];
+     auto const& maxHourlyPumpPower = area.hydro.series->maxHourlyPumpPower;
+     auto const& maxDailyPumpEnergy = area.hydro.maxDailyPumpEnergy[0];
 
     // If pumping energy is nil over the whole year, pumpHasMod is false, true otherwise.
-    pumpHasMod = CheckForPositiveEnergy(maxPumpingP, maxPumpHours);
+    pumpHasMod = CheckForPositiveEnergy(maxHourlyPumpPower, maxDailyPumpEnergy);
 }
 
 AreaScratchpad::~AreaScratchpad() = default;

src/libs/antares/study/area/store-timeseries-numbers.cpp

@@ -48,7 +48,7 @@ struct TSNumbersPredicate
 };
 } // anonymous namespace
 
-static void genericStoreTimeseriesNumbers(Solver::IResultWriter::Ptr writer,
+static void storeTSnumbers(Solver::IResultWriter::Ptr writer,
                                           const Matrix<uint32_t>& timeseriesNumbers,
                                           const String& id,
                                           const String& directory)
@@ -69,28 +69,28 @@ static void genericStoreTimeseriesNumbers(Solver::IResultWriter::Ptr writer,
 
 void storeTimeseriesNumbersForLoad(Solver::IResultWriter::Ptr writer, const Area& area)
 {
-    genericStoreTimeseriesNumbers(writer, area.load.series->timeseriesNumbers, area.id, "load");
+    storeTSnumbers(writer, area.load.series->timeseriesNumbers, area.id, "load");
 }
 
 void storeTimeseriesNumbersForSolar(Solver::IResultWriter::Ptr writer, const Area& area)
 {
-    genericStoreTimeseriesNumbers(writer, area.solar.series->timeseriesNumbers, area.id, "solar");
+    storeTSnumbers(writer, area.solar.series->timeseriesNumbers, area.id, "solar");
 }
 
 void storeTimeseriesNumbersForHydro(Solver::IResultWriter::Ptr writer, const Area& area)
 {
-    genericStoreTimeseriesNumbers(writer, area.hydro.series->timeseriesNumbers, area.id, "hydro");
+    storeTSnumbers(writer, area.hydro.series->timeseriesNumbers, area.id, "hydro");
 }
 
 
-void storeTimeseriesNumbersForHydroPowerCredits(Solver::IResultWriter::Ptr writer, const Area& area)
+void storeTimeseriesNumbersForHydroMaxPower(Solver::IResultWriter::Ptr writer, const Area& area)
 {
-    genericStoreTimeseriesNumbers(writer, area.hydro.series->timeseriesNumbersPowerCredits, area.id, "power-credits");
+    storeTSnumbers(writer, area.hydro.series->timeseriesNumbersHydroMaxPower, area.id, "max-power");
 }
 
 void storeTimeseriesNumbersForWind(Solver::IResultWriter::Ptr writer, const Area& area)
 {
-    genericStoreTimeseriesNumbers(writer, area.wind.series->timeseriesNumbers, area.id, "wind");
+    storeTSnumbers(writer, area.wind.series->timeseriesNumbers, area.id, "wind");
 }
 
 void storeTimeseriesNumbersForThermal(Solver::IResultWriter::Ptr writer, const Area& area)

src/libs/antares/study/area/store-timeseries-numbers.h

@@ -46,7 +46,7 @@ namespace Antares::Data
     void storeTimeseriesNumbersForThermal(Solver::IResultWriter::Ptr writer, const Area& area);
     void storeTimeseriesNumbersForRenewable(Solver::IResultWriter::Ptr writer, const Area& area);
     void storeTimeseriesNumbersForTransmissionCapacities(Solver::IResultWriter::Ptr writer, const Area& area);
-    void storeTimeseriesNumbersForHydroPowerCredits(Solver::IResultWriter::Ptr writer, const Area& area);
+    void storeTimeseriesNumbersForHydroMaxPower(Solver::IResultWriter::Ptr writer, const Area& area);
 
 } //Antares::Data
 

src/libs/antares/study/area/store-timeseries-numbers.hxx

@@ -62,8 +62,8 @@ void singleAreaStoreTimeseriesNumbers(Solver::IResultWriter::Ptr writer, const A
     case timeSeriesTransmissionCapacities:
         storeTimeseriesNumbersForTransmissionCapacities(writer, area);
         break;
-    case timeSeriesHydroPowerCredits:
-        storeTimeseriesNumbersForHydroPowerCredits(writer, area);
+    case timeSeriesHydroMaxPower:
+        storeTimeseriesNumbersForHydroMaxPower(writer, area);
         break;
     case timeSeriesCount:
     default:

src/libs/antares/study/cleaner/cleaner-v20.cpp

@@ -87,11 +87,9 @@ static void listOfFilesAnDirectoriesToKeepForArea(PathList& e, PathList& p, cons
     e.add(buffer);
     buffer.clear() << "input/hydro/common/capacity/inflowPattern_" << id << ".txt";
     e.add(buffer);
-    buffer.clear() << "input/hydro/common/capacity/maxpower_" << id << ".txt";
+    buffer.clear() << "input/hydro/common/capacity/maxDailyGenEnergy_" << id << ".txt";
     e.add(buffer);
-    buffer.clear() << "input/hydro/common/capacity/maxhoursGen_" << id << ".txt";
-    e.add(buffer);
-    buffer.clear() << "input/hydro/common/capacity/maxhoursPump_" << id << ".txt";
+    buffer.clear() << "input/hydro/common/capacity/maxDailyPumpEnergy_" << id << ".txt";
     e.add(buffer);
     buffer.clear() << "input/hydro/common/capacity/reservoir_" << id << ".txt";
     e.add(buffer);
@@ -103,9 +101,9 @@ static void listOfFilesAnDirectoriesToKeepForArea(PathList& e, PathList& p, cons
     e.add(buffer);
     buffer.clear() << "input/hydro/series/" << id << "/mingen.txt";
     e.add(buffer);
-    buffer.clear() << "input/hydro/series/" << id << "/maxgen.txt";
+    buffer.clear() << "input/hydro/series/" << id << "/maxHourlyGenPower.txt";
     e.add(buffer);
-    buffer.clear() << "input/hydro/series/" << id << "/maxpump.txt";
+    buffer.clear() << "input/hydro/series/" << id << "/maxHourlyPumpPower.txt";
     e.add(buffer);
     buffer.clear() << "input/hydro/allocation/" << id << ".ini";
     p.add(buffer);

src/libs/antares/study/fwd.h

@@ -221,8 +221,8 @@ enum TimeSeries : unsigned int
     timeSeriesRenewable = 32,
     //! TimeSeries : Renewable
     timeSeriesTransmissionCapacities = 64,
-    //! TimeSeries : Hydro Power Credits
-    timeSeriesHydroPowerCredits = 256,
+    //! TimeSeries : Hydro Max Power
+    timeSeriesHydroMaxPower = 256,
 
     //! The maximum number of time-series that we can encounter
     timeSeriesCount = 8,

src/libs/antares/study/parameters.cpp

@@ -74,8 +74,8 @@ static bool ConvertCStrToListTimeSeries(const String& value, uint& v)
             v |= timeSeriesRenewable;
         else if (word == "ntc")
             v |= timeSeriesTransmissionCapacities;
-        else if (word == "power-credits")
-            v |= timeSeriesHydroPowerCredits;
+        else if (word == "max-power")
+            v |= timeSeriesHydroMaxPower;
         return true;
     });
     return true;
@@ -394,11 +394,11 @@ static void ParametersSaveTimeSeries(IniFile::Section* s, const char* name, uint
             v += ", ";
         v += "ntc";
     }
-    if (value & timeSeriesHydroPowerCredits)
+    if (value & timeSeriesHydroMaxPower)
     {
         if (!v.empty())
             v += ", ";
-        v += "power-credits";
+        v += "max-power";
     }
     s->add(name, v);
 }
@@ -1081,7 +1081,7 @@ bool Parameters::loadFromINI(const IniFile& ini, uint version, const StudyLoadOp
 
     fixGenRefreshForNTC();
 
-    fixGenRefreshForHydroPowerCredits();
+    fixGenRefreshForHydroMaxPower();
 
     // Specific action before launching a simulation
     if (options.usedByTheSolver)
@@ -1141,18 +1141,18 @@ void Parameters::fixGenRefreshForNTC()
     }
 }
 
-void Parameters::fixGenRefreshForHydroPowerCredits()
+void Parameters::fixGenRefreshForHydroMaxPower()
 {
-    if ((timeSeriesHydroPowerCredits & timeSeriesToGenerate) != 0)
+    if ((timeSeriesHydroMaxPower & timeSeriesToGenerate) != 0)
     {
-        timeSeriesToGenerate &= ~timeSeriesHydroPowerCredits;
-        logs.error() << "Time-series generation is not available for hydro power credits. It "
+        timeSeriesToGenerate &= ~timeSeriesHydroMaxPower;
+        logs.error() << "Time-series generation is not available for hydro max power. It "
                         "will be automatically disabled.";
     }
-    if ((timeSeriesHydroPowerCredits & timeSeriesToRefresh) != 0)
+    if ((timeSeriesHydroMaxPower & timeSeriesToRefresh) != 0)
     {
-        timeSeriesToRefresh &= ~timeSeriesHydroPowerCredits;
-        logs.error() << "Time-series refresh is not available for hydro power credits. It will "
+        timeSeriesToRefresh &= ~timeSeriesHydroMaxPower;
+        logs.error() << "Time-series refresh is not available for hydro max power. It will "
                         "be automatically disabled.";
     }
 }
@@ -1401,7 +1401,7 @@ void Parameters::prepareForSimulation(const StudyLoadOptions& options)
 
     if (interModal == timeSeriesLoad || interModal == timeSeriesSolar
         || interModal == timeSeriesWind || interModal == timeSeriesHydro
-        || interModal == timeSeriesThermal || interModal == timeSeriesRenewable || interModal == timeSeriesHydroPowerCredits)
+        || interModal == timeSeriesThermal || interModal == timeSeriesRenewable || interModal == timeSeriesHydroMaxPower)
     {
         // Only one timeseries in interModal correlation, which is the same than nothing
         interModal = 0;

src/libs/antares/study/parameters.h

@@ -161,9 +161,9 @@ class Parameters final
 
     /*!
     ** \brief Try to detect then fix TS generation/refresh parameters
-    *         for Hydro Power Credits
+    *         for Hydro Max Power
     */
-    void fixGenRefreshForHydroPowerCredits();
+    void fixGenRefreshForHydroMaxPower();
 
     /*!
     ** \brief Get the amount of memory used by the general data