Antares::Solver::Variable::State Class Reference

Public Member Functions
	State (Data::Study &s)
void	initFromAreaIndex (const unsigned int areaIndex, uint numSpace)
	Initialize some variables according an area index.
void	initFromThermalClusterIndex (const unsigned int clusterEnabledIndex)
	Initialize some variable according a thermal cluster index.
void	yearEndBuildFromThermalClusterIndex (const unsigned int clusterEnabledIndex)
	End the year by smoothing the thermal units run and computing costs. We assume here that the variables related to an area are properly initialized.
void	startANewYear ()
	Reset internal data.
void	yearEndResetThermal ()
	Reset thermal internal data for end of year calculations.

Public Attributes
unsigned int	year
	Current year.
unsigned int	weekInTheYear
	Current week for current year (zero-based)
unsigned int	hourInTheYear
	Current hour in the year (zero-based)
unsigned int	hourInTheWeek
	Current hour in the week (zero-based)
unsigned int	hourInTheSimulation
	Current hour from the begining of the simulation.
Data::Area *	area
	The current area.
Data::ThermalCluster *	thermalCluster
	The current thermal cluster (used in yearEndBuildForEachThermalCluster functions)
Data::RenewableCluster *	renewableCluster
	The current renewable cluster.
Data::AreaScratchpad *	scratchpad
	The Scratchpad for the current area.
Data::AreaLink *	link
	The current link.
Adequacy
Matrix	resSpilled
	Spilled energy for all areas in the week.
Economy
RESULTATS_HORAIRES *	hourlyResults
VALEURS_DE_NTC_ET_RESISTANCES	ntc
	NTC Values.
double	thermalClusterProductionForYear [HOURS_PER_YEAR]
	Thermal production for the current thermal cluster for the whole year.
uint	thermalClusterDispatchedUnitsCountForYear [HOURS_PER_YEAR]
double	thermalClusterOperatingCostForYear [HOURS_PER_YEAR]
	Thermal operating cost for the current thermal cluster for the whole year.
double	thermalClusterNonProportionalCostForYear [HOURS_PER_YEAR]
	Thermal NP Cost for the current thermal cluster for the whole year.
double	thermalClusterPMinOfTheClusterForYear [HOURS_PER_YEAR]
	Minimum power of the cluster for the whole year.
double	renewableClusterProduction
const double *	dispatchableMargin
	Dispatchable margin for the current area (valid only from weekForEachArea)
PROBLEME_HEBDO *	problemeHebdo
	Probleme Hebdo.
Data::SimulationMode	simulationMode
	Simulation mode: economy / adequacy / expansion.
Data::UnitCommitmentMode	unitCommitmentMode
	Study unit commitment mode: fast(ucHeuristic) / accurate(ucMILP)
Data::Study &	study
	Reference to the original study.
ThermalState	thermal
unsigned int	numSpace
	Index of the state in the state vector.
bool	simplexRunNeeded
	Flag to know if the simplex has been used for the current week.
double	annualSystemCost = 0.
double	optimalSolutionCost1 = 0.
	Sum of the weekly optimal costs over the year (first optimisation step)
double	optimalSolutionCost2 = 0.
	Sum of the weekly optimal costs over the year (second optimisation step)
double	averageOptimizationTime1 = 0.
	Average time spent in first optimization over the year (ms)
double	averageOptimizationTime2 = 0.
	Average time spent in second optimization over the year (ms)
double	averageUpdateTime = 0.
	Average time spent updating the problem over the year (ms)

Member Function Documentation

initFromAreaIndex()

void Antares::Solver::Variable::State::initFromAreaIndex ( const unsigned int areaIndex, uint numSpace )

inline

Initialize some variables according an area index.

Parameters

areaIndex

Index of the area

initFromThermalClusterIndex()

void Antares::Solver::Variable::State::initFromThermalClusterIndex

(

const unsigned int

clusterEnabledIndex

)

Initialize some variable according a thermal cluster index.

We assume here that the variables related to an area are properly initialized.

Parameters

clusterEnabledIndex

Index of the thermal cluster for the current area

yearEndBuildFromThermalClusterIndex()

void Antares::Solver::Variable::State::yearEndBuildFromThermalClusterIndex

(

const unsigned int

clusterEnabledIndex

)

End the year by smoothing the thermal units run and computing costs. We assume here that the variables related to an area are properly initialized.

Parameters

clusterEnabledIndex

Index of the thermal cluster for the current area

Member Data Documentation

thermalClusterDispatchedUnitsCountForYear

uint Antares::Solver::Variable::State::thermalClusterDispatchedUnitsCountForYear[HOURS_PER_YEAR]

Number of unit dispatched for all clusters for the whole year for ucHeruistic (fast) or ucMILP (accurate)

---

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

• src/solver/variable/include/antares/solver/variable/state.h
• src/solver/variable/include/antares/solver/variable/state.hxx
• src/solver/variable/state.cpp