LandCover Class Reference

Inheritance diagram for LandCover:

Public Member Functions
bool	CanHaveAreaFraction () override
double	GetAreaFraction ()
double *	GetAreaFractionPointer ()
void	SetAreaFraction (double value)
bool	IsLandCover () override
bool	IsNull () override
virtual void	SurfaceComponentAdded (SurfaceComponent *brick)
Public Member Functions inherited from Brick
virtual void	SetParameters (const BrickSettings &brickSettings)
virtual void	AttachFluxIn (Flux *flux)
void	AddProcess (Process *process)
virtual void	Reset ()
virtual void	SaveAsInitialState ()
virtual bool	IsOk ()
bool	NeedsSolver () const
virtual bool	IsSnowpack ()
virtual bool	IsGlacier ()
virtual void	Finalize ()
virtual void	SetInitialState (double value, const string &type="water")
virtual double	GetContent (const string &type="water")
virtual void	UpdateContent (double value, const string &type="water")
virtual void	UpdateContentFromInputs ()
virtual void	ApplyConstraints (double timeStep)
WaterContainer *	GetWaterContainer ()
Process *	GetProcess (int index)
vector< Process * > &	GetProcesses ()
string	GetName ()
void	SetName (const string &name)
HydroUnit *	GetHydroUnit ()
void	SetHydroUnit (HydroUnit *hydroUnit)
virtual vecDoublePt	GetDynamicContentChanges ()
vecDoublePt	GetStateVariableChangesFromProcesses ()
int	GetProcessesConnectionsNb ()
double *	GetBaseValuePointer (const string &name)
virtual double *	GetValuePointer (const string &name)

Protected Attributes
double	_areaFraction
Protected Attributes inherited from Brick
string	_name
bool	_needsSolver
WaterContainer *	_water
vector< Process * >	_processes
HydroUnit *	_hydroUnit

Additional Inherited Members
Static Public Member Functions inherited from Brick
static Brick *	Factory (const BrickSettings &brickSettings)
static bool	HasParameter (const BrickSettings &brickSettings, const string &name)
static float *	GetParameterValuePointer (const BrickSettings &brickSettings, const string &name)

Member Function Documentation

CanHaveAreaFraction()

bool LandCover::CanHaveAreaFraction ( )

inlineoverridevirtual

Check if the brick can have an area fraction.

Returns

true if the brick can have an area fraction.

Reimplemented from Brick.

GetAreaFraction()

double LandCover::GetAreaFraction ( )

inline

Get the area fraction of the land cover.

Returns

The area fraction of the land cover.

GetAreaFractionPointer()

double * LandCover::GetAreaFractionPointer ( )

inline

Get a pointer to the area fraction of the land cover.

Returns

A pointer to the area fraction of the land cover.

IsLandCover()

bool LandCover::IsLandCover ( )

inlineoverridevirtual

Check if the brick is a land cover.

Returns

true if the brick is a land cover.

Reimplemented from Brick.

IsNull()

bool LandCover::IsNull ( )

inlineoverridevirtual

Check if the brick is null (e.g., if the area fraction is null).

Returns

true if the brick is null.

Reimplemented from Brick.

SetAreaFraction()

void LandCover::SetAreaFraction

(

double

value

)

Set the area fraction of the land cover.

Parameters

value

The area fraction to set.

SurfaceComponentAdded()

void LandCover::SurfaceComponentAdded ( SurfaceComponent * brick )

virtual

Called when a new surface component is added to the land cover.

Parameters

brick

The surface component that was added.

Reimplemented in Glacier.

---

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

• /github/workspace/core/src/bricks/LandCover.h
• /github/workspace/core/src/bricks/LandCover.cpp