Multiple Maximum Generation and Pumping for Hydro (Merging with develop branch)

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.
+  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, 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". 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
@@ -295,11 +295,11 @@ which explains the comparatively long length of this chapter.
 
 In the main Window, the user may pick any area appearing in the list and is then given access to different tabs:
 
-- The "time-series" tab displays the "ready-made" time-series already available for simulation purposes. There are two categories of time-series (displayed in two different subtabs): the Run of River (ROR) time-series on the one hand and the Storage power (SP) time-series on the other hand.
+- The "time-series" tab displays the "ready-made" time-series already available for simulation purposes. There are five categories of time-series (displayed in five different subtabs): the Run of River (ROR) time-series, the Storage power (SP) time-series, the Minimum Generation power, the Maximum Generation power and the Maximum Pumping Power.
 
-    ROR time-series are defined at the hourly scale; each of the 8760 values represents the ROR power expected at a given hour, expressed in round number and in MW. The SP time-series are defined at the daily scale; each of the 365 values represents an overall SP energy expected in the day, expressed in round number and in MWh. These natural inflows are considered to be storable into a reservoir for later use.
+    ROR time-series are defined at the hourly scale; each of the 8760 values represents the ROR power expected at a given hour, expressed in round number and in MW. The SP time-series are defined at the daily scale; each of the 365 values represents an overall SP energy expected in the day, expressed in round number and in MWh. These natural inflows are considered to be storable into a reservoir for later use. The Minimum Generation time-series are defined at the hourly scale; each of the 8760 values represents the Minimum Generation power expected at a given hour expressed in round number and in MW. The Maximum Generation time-series are defined at the hourly scale; each of the 8760 values represents the Maximum Generation power expected at a given hour expressed in round number and in MW. The Maximum Pumping time-series are defined at the hourly scale; each of the 8760 values represents the Maximum Pumping power expected at a given hour expressed in round number and in MW.
 
-    Both types of data may come from any origin outside Antares, or may have been formerly generated by the Antares time-series stochastic generator and stored as input data on the user's request. Different ways to update data are:
+    ROR time-series and SP time-series may come from any origin outside Antares, or may have been formerly generated by the Antares time-series stochastic generator and stored as input data on the user's request. Minimum Generation, Maximum Generation and Maximum Pumping may come from any origin outside Antares, but they can not be generated by the Antares time-series stochastic generator. Different ways to update data are:
 
     - direct typing
     - copy/paste a selected field to/from the clipboard
@@ -313,7 +313,8 @@ In the main Window, the user may pick any area appearing in the list and is then
 
     - _Note that:_
 
-        - _For a given area, the number of ROR time-series and SP times-series **must** be identical_
+        - _For a given area, the number of ROR time-series, SP times-series and Minimum Generation **must** be identical_
+        - _For a given area, the number of Maximum Generation and Maximum Pumping **must** be identical_
         - _If the "intra-modal correlated draws" option was not selected in the_ **simulation** _window,
       MC adequacy or economy simulations can take place even if the number of hydro time-series is not the same
       in all areas (e.g. 2 , 5 , 1 , 45 ,...)_
@@ -376,10 +377,10 @@ the weekly optimal hydro-thermal unit-commitment and dispatch process.
 Standard credits (Bottom part)
 
 The bottom part displays two daily time-series (365 values) defined for energy generation/storage
-(hydro turbines or hydro pumps). In each case, the first array defines the maximum power (generated or absorbed),
-and the second defines the maximum daily energy (either generated or stored).
+(hydro turbines or hydro pumps). Both arrays represents the maximum daily energy (either generated or stored).
 
-For the sake of clarity, maximum daily energies are expressed as a number of hours at maximum power.
+For the sake of clarity, maximum daily energies are expressed as a number of hours at maximum power and these values
+are used along with the Maximum Generation and Maximum Pumping TS's to calculate daily mean energy.
 
 Credit modulation (Upper part)
 

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

@@ -18,6 +18,13 @@ Using this property requires OR-Tools and a MILP solver (XPRESS, COIN)
 ```
 antares-8.8-solver --use-ortools --ortools-solver coin|xpress ...
 ```
+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/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 Max Power`
+In the existing file **settings/scenariobuilder.dat**, under **<ruleset>** section following properties added:
+* **hgp,<area>,<year> = <hgp-value>**
 
 ## v8.7.0
 ### Input

src/libs/antares/constants.h

@@ -42,6 +42,8 @@
 /*! Hours per year */
 #define HOURS_PER_YEAR 8760
 
+#define HOURS_PER_DAY 24U
+
 namespace Antares::Constants
 {
 extern const std::array<unsigned int, 12> daysPerMonth;

src/libs/antares/series/series.cpp

@@ -141,5 +141,4 @@ uint64_t TimeSeries::memoryUsage() const
 {
     return timeSeries.memoryUsage();
 }
-
 } // namespace Antares::Data

src/libs/antares/study/CMakeLists.txt

@@ -23,6 +23,8 @@ set(SRC_STUDY_SCENARIO_BUILDER
         scenario-builder/ThermalTSNumberData.h
         scenario-builder/HydroTSNumberData.h
         scenario-builder/HydroTSNumberData.cpp
+        scenario-builder/HydroMaxPowerTSNumberData.h
+        scenario-builder/HydroMaxPowerTSNumberData.cpp
         scenario-builder/SolarTSNumberData.cpp
         scenario-builder/solarTSNumberData.h
         scenario-builder/WindTSNumberData.h
@@ -128,6 +130,8 @@ set(SRC_STUDY_PART_HYDRO
         parts/hydro/allocation.h
         parts/hydro/allocation.hxx
         parts/hydro/allocation.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

@@ -269,6 +269,7 @@ void Area::resizeAllTimeseriesNumbers(uint n)
         solar.series.timeseriesNumbers.clear();
         wind.series.timeseriesNumbers.clear();
         hydro.series->timeseriesNumbers.clear();
+        hydro.series->timeseriesNumbersHydroMaxPower.clear();
         for (auto& namedLink : links)
         {
             AreaLink* link = namedLink.second;
@@ -281,6 +282,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->timeseriesNumbersHydroMaxPower.resize(1, n);
         for (auto& namedLink : links)
         {
             AreaLink* link = namedLink.second;

src/libs/antares/study/area/area.h

@@ -336,7 +336,6 @@ class Area final : private Yuni::NonCopyable<Area>
     void createMissingTimeSeries();
     void createMissingPrepros();
 
-
 }; // class Area
 
 bool saveAreaOptimisationIniFile(const Area& area, const Yuni::Clob& buffer);

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

@@ -897,12 +897,41 @@ static bool AreaListLoadFromFolderSingleArea(Study& study,
             buffer.clear() << study.folderInput << SEP << "hydro" << SEP << "prepro";
             ret = area.hydro.prepro->loadFromFolder(study, area.id, buffer.c_str()) && ret;
         }
-        if (area.hydro.series && (!options.loadOnlyNeeded || !area.hydro.prepro)) // Series
+
+        auto* hydroSeries = area.hydro.series;
+        if (!options.loadOnlyNeeded || !area.hydro.prepro) // Series
         {
             buffer.clear() << study.folderInput << SEP << "hydro" << SEP << "series";
-            ret = area.hydro.series->loadFromFolder(study, area.id, buffer) && ret;
+            ret = hydroSeries->loadGenerationTS(area.id, buffer, study.header.version) && ret;
+
+            hydroSeries->EqualizeGenerationTSsizes(
+                area, study.usedByTheSolver, study.gotFatalError);
         }
 
+        if (study.header.version < 870)
+        {
+            buffer.clear() << study.folderInput << SEP << "hydro";
+
+            HydroMaxTimeSeriesReader reader;
+            ret = reader(buffer, area, study.usedByTheSolver) && ret;
+        }
+
+        if (study.header.version >= 870)
+        {
+            buffer.clear() << study.folderInput << SEP << "hydro" << SEP << "series";
+            ret = hydroSeries->LoadMaxPower(area.id, buffer) && ret;
+
+            if (study.usedByTheSolver)
+            {
+                hydroSeries->EqualizeMaxPowerTSsizes(area, study.gotFatalError);
+            }
+            else
+                hydroSeries->setHydroModulability(area);
+        }
+
+        hydroSeries->resizeTSinDeratedMode(
+            study.parameters.derated, study.header.version, study.usedByTheSolver);
+
         ++options.progressTicks;
         options.pushProgressLogs();
     }
@@ -1556,9 +1585,7 @@ void AreaList::removeLoadTimeseries()
 
 void AreaList::removeHydroTimeseries()
 {
-    each([](Data::Area& area) {
-        area.hydro.series->reset();
-    });
+    each([](Data::Area& area) { area.hydro.series->reset(); });
 }
 
 void AreaList::removeSolarTimeseries()