Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
Antares::Data::PreproHydro Class Reference

Data for the hydro preprocessor. More...

#include <prepro.h>

Public Types

enum  {
  expectation = 0 , stdDeviation , minimumEnergy , maximumEnergy ,
  powerOverWater , hydroPreproMax
}
 

Constructor

double intermonthlyCorrelation
 The intermonthly correlation value.
 
Matrix data
 data
 
 PreproHydro ()
 Default constructor.
 
void reset ()
 Reset all data to their default values.
 
void copyFrom (const PreproHydro &rhs)
 Copy data from another PreproHydro structure.
 
bool loadFromFolder (Study &s, const std::string &areaID, const std::filesystem::path &folder)
 Load hydro settings for the prepro from a folder.
 
bool validate (const std::string &areaID)
 
bool saveToFolder (const AreaName &areaID, const char *folder)
 Save hydro settings for the prepro into a folder.
 
bool forceReload (bool reload=false) const
 
void markAsModified () const
 

Detailed Description

Data for the hydro preprocessor.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
expectation 

The expectation of the total capacity (Espérance du logarithme de 'energie totale)

These values will be modified before launching a simulation. The solver requires log(expectaction) and log(stddeviation)

stdDeviation 

The standard deviation of the total capacity (ecart-type du logarithme de l'energie totale)

These values will be modified before launching a simulation. The solver requires log(expectaction) and log(stddeviation)

minimumEnergy 

Minimum capacity per month.

maximumEnergy 

Maximum capacity per month.

powerOverWater 

Power over water.

Proportion du fil de l'eau : l'hydraulique est representee au travers de son energie totale mensuelle; cette proportion est donc une proportion en énergie La valeur peut varier entre 0 (pas de fil de l'eau) et 1 (pas d'hydraulique modulable)

hydroPreproMax 

The maximum number of item.

Member Function Documentation

◆ loadFromFolder()

bool Antares::Data::PreproHydro::loadFromFolder ( Study & s,
const std::string & areaID,
const std::filesystem::path & folder )

Load hydro settings for the prepro from a folder.

Parameters
folderThe source folder (ex: input/hydro/prepro)
Returns
A non-zero value if the operation succeeded, 0 otherwise

◆ saveToFolder()

bool Antares::Data::PreproHydro::saveToFolder ( const AreaName & areaID,
const char * folder )

Save hydro settings for the prepro into a folder.

Parameters
folderThe target folder (ex: input/hydro/prepro)
Returns
A non-zero value if the operation succeeded, 0 otherwise

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