Glacier Class Reference

Inheritance diagram for Glacier:

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

Protected Attributes
IceContainer *	_ice
Protected Attributes inherited from LandCover
double	_areaFraction
Protected Attributes inherited from Brick
string	_name
bool	_needsSolver
std::unique_ptr< WaterContainer >	_water
vector< Process * >	_processes
HydroUnit *	_hydroUnit

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

Member Function Documentation

ApplyConstraints()

void Glacier::ApplyConstraints ( double timeStep )

overridevirtual

Apply the constraints to the water container.

Parameters

timeStep

time step for the simulation.

Reimplemented from Brick.

AttachFluxIn()

void Glacier::AttachFluxIn ( Flux * flux )

overridevirtual

Attach incoming flux.

Parameters

flux	incoming flux

Reimplemented from Brick.

Finalize()

void Glacier::Finalize ( )

overridevirtual

Finalize the water transfer.

Reimplemented from Brick.

GetContent()

double Glacier::GetContent ( ContentType type )

overridevirtual

Get the content of the water container.

Parameters

type	type of the content.

Returns

content of the water container.

Reimplemented from Brick.

GetDynamicContentChanges()

vecDoublePt Glacier::GetDynamicContentChanges ( )

overridevirtual

Get pointers to the state variables.

Returns

vector of pointers to the state variables.

Reimplemented from Brick.

GetIceContainer()

WaterContainer * Glacier::GetIceContainer

(

)

Get the ice container of the glacier.

Returns

The ice container of the glacier.

GetValuePointer()

double * Glacier::GetValuePointer ( const string & name )

overridevirtual

Get the pointer to the water container content.

Parameters

name	name of the container type (e.g., "water", "ice", or "snow").

Reimplemented from Brick.

IsGlacier()

bool Glacier::IsGlacier ( )

inlinenodiscardoverridevirtual

Check if the brick is a glacier.

Returns

true if the brick is a glacier.

Reimplemented from Brick.

IsOk()

bool Glacier::IsOk ( )

nodiscardoverridevirtual

Check that everything is correctly defined.

Returns

true is everything is correctly defined.

Reimplemented from Brick.

Reset()

void Glacier::Reset ( )

overridevirtual

Reset the brick to its initial state.

Reimplemented from Brick.

SaveAsInitialState()

void Glacier::SaveAsInitialState ( )

overridevirtual

Save the current state of the brick as the initial state.

Reimplemented from Brick.

SetInitialState()

void Glacier::SetInitialState ( double value, ContentType type )

overridevirtual

Set the initial state of the water container.

Parameters

value	initial state value.
type	type of the content.

Reimplemented from Brick.

SetParameters()

void Glacier::SetParameters ( const BrickSettings & brickSettings )

overridevirtual

Assign the parameters to the brick element.

Parameters

brickSettings

settings of the brick containing the parameters.

Reimplemented from Brick.

SurfaceComponentAdded()

void Glacier::SurfaceComponentAdded ( SurfaceComponent * brick )

overridevirtual

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

Parameters

brick

The surface component that was added.

Reimplemented from LandCover.

UpdateContent()

void Glacier::UpdateContent ( double value, ContentType type )

overridevirtual

Update the content of the water container.

Parameters

value	new content value.
type	type of the content

Reimplemented from Brick.

UpdateContentFromInputs()

void Glacier::UpdateContentFromInputs ( )

overridevirtual

Update the content of the water container from the inputs.

Reimplemented from Brick.

---

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

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