Definition for a single area. More...

#include <area.h>

Inheritance diagram for Antares::Data::Area:

Public Types
using	NameSet = std::set<AreaName>

using	Set = std::set<Area*, CompareAreaName>

using	LinkMap = std::map<Area*, AreaLink::Set, CompareAreaName>

using	Map = std::map<AreaName, Area*>

using	Vector = std::vector<Area*>

using	VectorConst = std::vector<const Area*>

using	List = std::list<Area*>

using	ScratchMap = std::map<const Area*, AreaScratchpad&>

using	NameMapping = std::map<AreaName, AreaName>
	Name mapping -> must be replaced by AreaNameMapping.

Public Member Functions
Constructor & Destructor
	Area ()
	Default constructor.

	Area (const AnyString &name)
	Constructor with a given name.

	Area (const AnyString &name, const AnyString &id)
	Constructor.

	~Area ()
	Destructor.

bool	isVisibleOnLayer (const size_t &layerID) const
	check visibility on layer

Memory management
bool	forceReload (bool reload=false) const
	Load all data not already loaded.

void	markAsModified () const
	Mark all areas as modified.

Thermal clusters min stable power validity checking
bool	thermalClustersMinStablePowerValidity (std::vector< YString > &output) const
	Check the validity of min stable power for all thermal clusters.

template<enum TimeSeriesType T>
XCast *	xcastData ()
	Get the XCast data according a given time-series type.

template<enum TimeSeriesType T>
const XCast *	xcastData () const

Public Attributes
General
AreaName	name
	Name of the area.

AreaName	id
	Name of the area in lowercase format.

uint	index = (uint)(-1)
	Index of the area - only valid when already added to an area list.

AdequacyPatch::AdequacyPatchMode	adequacyPatchMode = AdequacyPatch::physicalAreaOutsideAdqPatch
	Use adequacy patch for this area.

Associate data *‍/
Matrix	reserves
	Reserves.

Matrix	miscGen
	Misc Gen.

Load
Load::Container	load

Solar
Solar::Container	solar

Hydro
PartHydro	hydro

Wind
Wind::Container	wind
	Wind time-series and Wind prepro data.

Thermal
PartThermal	thermal

Renewable
PartRenewable	renewable

ShortTermStorage::STStorageInput	shortTermStorage

Interconnections
AreaLink::Map	links
	All connections with this area.

Nodal Optimization
uint	nodalOptimization = anoAll
	Nodal optimization (see AreaNodalOptimization)

Spread
double	spreadUnsuppliedEnergyCost = 0.
	Spread for the unsupplied energy cost.

double	spreadSpilledEnergyCost = 0.
	Spread for the spilled energy cost.

Output filtering
uint	filterSynthesis = filterAll
	Print results for the area in the simulation synthesis.

uint	filterYearByYear = filterAll
	Print results for the area in the year-by-year mode.

UI
std::unique_ptr< AreaUI >	ui
	Information for the UI.

Dynamic
std::vector< AreaScratchpad >	scratchpad
	Scratchpad used temporary calculations (solver only)

Data
bool	invalidateJIT = false
	Invalidate (JIT)

Links
void	clearAllLinks ()
	Destroy all links.

void	detachAllLinks ()
	Properly detach all links attached to an area.

AreaLink *	findLinkByID (const AreaName &id)
	Try to find the attached link from another area id.

const AreaLink *	findLinkByID (const AreaName &id) const

void	detachLinkFromID (const AreaName &id)
	Detach any link connected from this area to the given area.

void	detachLinkFromItsPointer (const AreaLink *lnk)
	Remove a link from its raw pointer.

void	buildLinksIndexes ()

void	createMissingData ()
	Ensure all data are created.

void	resetToDefaultValues ()
	Reset all values to their default one.

void	resizeAllTimeseriesNumbers (uint nbYears)
	Resize all matrices dedicated to the sampled timeseries numbers.

AreaLink *	findExistingLinkWith (Area &with)
	Check if a link with another area is already established.

const AreaLink *	findExistingLinkWith (const Area &with) const

static void	detachLink (const AreaLink *lnk)

Detailed Description

Definition for a single area.

Constructor & Destructor Documentation

◆ Area() [1/2]

Antares::Data::Area::Area ( const AnyString & name )

explicit

Constructor with a given name.

Parameters

name	The name of the area

◆ Area() [2/2]

Antares::Data::Area::Area	(	const AnyString &	name,
		const AnyString &	id )

Constructor.

Parameters

name	Name of the area
id	id of the area

Member Function Documentation

◆ detachAllLinks()

void Antares::Data::Area::detachAllLinks ( )

Properly detach all links attached to an area.

It is the safe way to add an area and it is mainly used by the GUI

◆ findExistingLinkWith()

AreaLink * Antares::Data::Area::findExistingLinkWith ( Area & with )

Check if a link with another area is already established.

Parameters

with Any area

Returns: A pointer to an existing link if found, NULL otherwise

◆ forceReload()

bool Antares::Data::Area::forceReload ( bool reload = false ) const

Load all data not already loaded.

If the load-on-demand is enabled, some data might not be loaded (see Matrix) However, we would like to be able to force the load of all data, especially when saving a study. The flag invalidateJIT will be reset to false.

Parameters

reload True to force the reload of data

Returns: True if the operation succeeded

◆ resizeAllTimeseriesNumbers()

void Antares::Data::Area::resizeAllTimeseriesNumbers ( uint nbYears )

Resize all matrices dedicated to the sampled timeseries numbers.

Parameters

n	A number of years

◆ thermalClustersMinStablePowerValidity()

bool Antares::Data::Area::thermalClustersMinStablePowerValidity ( std::vector< YString > & output ) const

Check the validity of min stable power for all thermal clusters.

Returns: True if the value of min stable power is a good one

Member Data Documentation

◆ invalidateJIT

bool Antares::Data::Area::invalidateJIT = false

mutable

Invalidate (JIT)

A non-zero value if the missing data must be loaded from HDD for the next save (only valid if JIT enabled).

◆ miscGen

Matrix Antares::Data::Area::miscGen

Misc Gen.

(previously called Fatal hors hydro) - fhhMax * HOURS_PER_YEAR The sum is done in runtimeinfos.cpp

◆ reserves

Matrix Antares::Data::Area::reserves

Reserves.

Reserves, DSM, D-1...

See also: enum ReservesIndex

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

src/libs/antares/study/include/antares/study/area/area.h
src/libs/antares/study/area/area.cpp
src/libs/antares/study/area/list.cpp
src/libs/antares/study/include/antares/study/area/area.hxx

Public Types

Public Member Functions

Public Attributes

Data

Links

Detailed Description

Constructor & Destructor Documentation

◆ Area() [1/2]

◆ Area() [2/2]

Member Function Documentation

◆ detachAllLinks()

◆ findExistingLinkWith()

◆ forceReload()

◆ resizeAllTimeseriesNumbers()

◆ thermalClustersMinStablePowerValidity()

Member Data Documentation

◆ invalidateJIT

◆ miscGen

◆ reserves