Snowpack Class Reference

Inheritance diagram for Snowpack:

Public Member Functions
void	Reset () override
void	SaveAsInitialState () override
void	SetParameters (const BrickSettings &brickSettings) override
void	AttachFluxIn (Flux *flux) override
bool	IsOk () override
WaterContainer *	GetSnowContainer ()
bool	IsSnowpack () 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
bool	HasSnow ()
Public Member Functions inherited from SurfaceComponent
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
void	AddProcess (Process *process)
bool	NeedsSolver () const
virtual bool	IsGlacier ()
virtual bool	IsLandCover ()
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
SnowContainer *	_snow
Protected Attributes inherited from SurfaceComponent
LandCover *	_parent
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 Snowpack::ApplyConstraints ( double timeStep )

overridevirtual

Apply the constraints to the water container.

Parameters

timeStep

time step for the simulation.

Reimplemented from Brick.

AttachFluxIn()

void Snowpack::AttachFluxIn ( Flux * flux )

overridevirtual

Attach incoming flux.

Parameters

flux	incoming flux

Reimplemented from Brick.

Finalize()

void Snowpack::Finalize ( )

overridevirtual

Finalize the water transfer.

Reimplemented from Brick.

GetContent()

double Snowpack::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 Snowpack::GetDynamicContentChanges ( )

overridevirtual

Get pointers to the state variables.

Returns

vector of pointers to the state variables.

Reimplemented from Brick.

GetSnowContainer()

WaterContainer * Snowpack::GetSnowContainer

(

)

Get the snow container.

Returns

A pointer to the snow container.

GetValuePointer()

double * Snowpack::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.

HasSnow()

bool Snowpack::HasSnow ( )

nodiscard

Check if the snowpack has snow.

Returns

True if the snowpack has snow, false otherwise.

IsOk()

bool Snowpack::IsOk ( )

nodiscardoverridevirtual

Check that everything is correctly defined.

Returns

true is everything is correctly defined.

Reimplemented from Brick.

IsSnowpack()

bool Snowpack::IsSnowpack ( )

inlinenodiscardoverridevirtual

Check if the brick is a snowpack.

Returns

true if the brick is a snowpack.

Reimplemented from Brick.

Reset()

void Snowpack::Reset ( )

overridevirtual

Reset the brick to its initial state.

Reimplemented from Brick.

SaveAsInitialState()

void Snowpack::SaveAsInitialState ( )

overridevirtual

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

Reimplemented from Brick.

SetInitialState()

void Snowpack::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 Snowpack::SetParameters ( const BrickSettings & brickSettings )

overridevirtual

Assign the parameters to the brick element.

Parameters

brickSettings

settings of the brick containing the parameters.

Reimplemented from Brick.

UpdateContent()

void Snowpack::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 Snowpack::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/Snowpack.h
• /github/workspace/core/src/bricks/Snowpack.cpp