Antares::Data::PartHydro Class Reference

Hydro for a single area. More...

#include <container.h>

Public Types
enum	{ minimum = 0 , average , maximum }
enum	weeklyHydroMod { genMod = 0 , pumpMod }

Public Member Functions
	PartHydro ()
	Default Constructor.
	~PartHydro ()=default
	Destructor.
void	reset ()
	Reset internal data.
void	copyFrom (const PartHydro &rhs)
bool	forceReload (bool reload=false) const
void	markAsModified () const
	Mark all data as modified.
bool	LoadDailyMaxEnergy (const std::filesystem::path &folder, const std::string &areaid)
	Load daily max energy.
bool	CheckDailyMaxEnergy (const AnyString &areaName)

Static Public Member Functions
static bool	LoadIniFile (Study &study, const std::filesystem::path &folder)
static bool	LoadFromFolder (Study &study, const std::filesystem::path &folder)
	Load data for hydro container from a folder.
static bool	validate (Study &study)
	Check and validate the loaded datas.
static bool	SaveToFolder (const AreaList &areas, const AnyString &folder, const Parameters::Compatibility::HydroPmax hydroPmax)
	Save data from several containers to a folder (except data for the prepro and time-series)

Public Attributes
double	interDailyBreakdown
	Inter-daily breakdown (previously called Smoothing Factor or alpha)
double	intraDailyModulation
	Intra-daily modulation.
double	intermonthlyBreakdown
	Intermonthly breakdown.
bool	reservoirManagement
	Enabled reservoir management.
bool	followLoadModulations
	Following load modulation.
bool	useWaterValue
	Use water values.
bool	hardBoundsOnRuleCurves
	Hard bound on rule curves.
bool	useHeuristicTarget
	Use heuristic target.
double	reservoirCapacity
	Reservoir capacity (MWh)
int	initializeReservoirLevelDate
	Initialize reservoir level date (month)
bool	useLeeway
	Use Leeway.
bool	powerToLevel
	Power to level modulations.
double	leewayLowerBound
	Leeway low bound.
double	leewayUpperBound
	Leeway upper bound.
double	pumpingEfficiency
	Puming efficiency.
Matrix< double, double >	dailyMaxPumpAndGen
Matrix< double, double >	creditModulation
	Credit Modulation (default 0, 101 * 2)
Matrix< double >	inflowPattern
	Daily Inflow Patern ([default 1, 0<x<dayspermonth]x365)
Matrix< double >	reservoirLevel
	Daily reservoir level ({min,avg,max}x365)
Matrix< double >	waterValues
	Daily water value ({0,1,2%...100%}x365)
HydroAllocation	allocation
	Hydro allocation, from other areas.
std::unique_ptr< PreproHydro >	prepro
	Data for the pre-processor.
std::unique_ptr< DataSeriesHydro >	series
	Data for time-series.
Matrix< double, double >	dailyNbHoursAtGenPmax
Matrix< double, double >	dailyNbHoursAtPumpPmax
std::unordered_map< uint, AreaDependantHydroManagementData >	managementData
std::vector< std::optional< double > >	deltaBetweenFinalAndInitialLevels
double	overflowSpilledCostDifference = 1.

Detailed Description

Hydro for a single area.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
minimum	The minimum value.
average	The average value.
maximum	The maximum value.

weeklyHydroMod

enum Antares::Data::PartHydro::weeklyHydroMod

Enumerator
genMod	Weekly generating modulation.
pumpMod	Weekly pumping modulation.

Member Function Documentation

LoadFromFolder()

bool Antares::Data::PartHydro::LoadFromFolder ( Study & study, const std::filesystem::path & folder )

static

Load data for hydro container from a folder.

Parameters

folder

The targer folder

Returns

A non-zero value if the operation succeeded, 0 otherwise

SaveToFolder()

bool Antares::Data::PartHydro::SaveToFolder ( const AreaList & areas, const AnyString & folder, const Parameters::Compatibility::HydroPmax hydroPmax )

static

Save data from several containers to a folder (except data for the prepro and time-series)

Parameters

l	List of areas
folder	The targer folder

Returns

A non-zero value if the operation succeeded, 0 otherwise

validate()

bool Antares::Data::PartHydro::validate ( Study & study )

static

Check and validate the loaded datas.

Returns

A non-zero value if the operation succeeded, 0 otherwise

Member Data Documentation

dailyMaxPumpAndGen

Matrix<double, double> Antares::Data::PartHydro::dailyMaxPumpAndGen

Daily max power ({generating max Power, generating max energy, pumping max power, pumping max energy}x365)

---

The documentation for this class was generated from the following files:

• src/libs/antares/study/include/antares/study/parts/hydro/container.h
• src/libs/antares/study/parts/hydro/container.cpp