Inheritance diagram for SurfaceComponent:

Public Member Functions
bool	CanHaveAreaFraction () override

double	GetAreaFraction () const

void	SetAreaFraction (double value)

double	GetParentAreaFraction ()

bool	IsNull () override

virtual void	SetParent (LandCover *parent)

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 bool	IsLandCover ()

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
LandCover *	_parent

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 SurfaceComponent::CanHaveAreaFraction ( )

inlineoverridevirtual

Check if the brick can have an area fraction.

Reimplemented from Brick.

double SurfaceComponent::GetAreaFraction ( ) const

inline

Gets the area fraction of this component.

double SurfaceComponent::GetParentAreaFraction ( )

Gets the area fraction of the parent land cover of this component.

bool SurfaceComponent::IsNull ( )

overridevirtual

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

Reimplemented from Brick.

void SurfaceComponent::SetAreaFraction ( double value )

Sets the area fraction of this component.

Parameters

value The area fraction of this component.

virtual void SurfaceComponent::SetParent ( LandCover * parent )

inlinevirtual

Sets the parent land cover of this component.

Parameters

parent The parent land cover of this component.

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