#include <ProcessOutflowSnowHolding.h>

Inheritance diagram for ProcessOutflowSnowHolding:

Public Member Functions
	ProcessOutflowSnowHolding (WaterContainer *container)

bool	IsValid () const override

void	SetParameters (const ProcessSettings &processSettings) override

Public Member Functions inherited from ProcessOutflow
	ProcessOutflow (WaterContainer *container)

int	GetConnectionCount () const override

double *	GetValuePointer (std::string_view name) override

Public Member Functions inherited from Process
	Process (WaterContainer *container)

virtual void	Reset ()

virtual void	Validate () const

virtual void	SetHydroUnitProperties (HydroUnit unit, Brick brick)

virtual void	AttachForcing (Forcing *)

void	AttachFluxOut (std::unique_ptr< Flux > flux)

int	GetOutputFluxCount () const

Flux *	GetOutputFlux (size_t index) const

virtual bool	ToAtmosphere () const

virtual bool	NeedsTargetBrickLinking () const

virtual vecDouble	GetChangeRates ()

virtual void	StoreInOutgoingFlux (double *rate, int index)

void	ApplyChange (int connectionIndex, double rate, double timeStepInDays)

virtual void	Finalize ()

virtual vecDoublePt	GetStateVariables ()

const string &	GetName () const

void	SetName (const string &name)

void	SetTimeMachine (TimeMachine *timeMachine)

WaterContainer *	GetWaterContainer () const

virtual void	SetTargetBrick (Brick *)

virtual bool	LinksMultipleTargets () const

virtual void	AddTargetBrickWithWeights (Brick , const std::vector< Brick > &)

virtual bool	IsLateralProcess () const noexcept

bool	HasOutputFluxes () const noexcept

bool	HasWaterContainer () const noexcept

Static Public Member Functions
static void	RegisterProcessSettings (SettingsModel *modelSettings)

Static Public Member Functions inherited from ProcessOutflow
static void	RegisterProcessSettings (SettingsModel *modelSettings)

Static Public Member Functions inherited from Process
static std::unique_ptr< Process >	Factory (const ProcessSettings &processSettings, Brick *brick)

static bool	RegisterSettings (SettingsModel *modelSettings, const string &processType)

static bool	HasParameter (const ProcessSettings &processSettings, std::string_view name)

static const float *	GetParameterValuePointer (const ProcessSettings &processSettings, std::string_view name)

Protected Member Functions
vecDouble	GetRates () override

Protected Member Functions inherited from Process
double	GetSumChangeRatesOtherProcesses () const

Protected Attributes
const float *	_waterHoldingCapacity

Protected Attributes inherited from Process
string	_name

WaterContainer *	_container

TimeMachine *	_timeMachine {nullptr}

std::vector< std::unique_ptr< Flux > >	_outputs

Detailed Description

Snowpack liquid water release with a holding capacity (HBV; Lindström et al., 1997).

Lives on the water container of a snowpack brick (requires snowpacks generated with water retention). The snowpack retains liquid water (rain on snow and melt water) up to a fraction of the snow water equivalent: outflow = max(0, W − whc × SWE)

The excess is released within the timestep. When no snow is present, all the liquid water is passed through to the target (usually the parent land cover).

Member Function Documentation

◆ GetRates()

vecDouble ProcessOutflowSnowHolding::GetRates ( )

overrideprotectedvirtual

Get the rates of the process.

Returns: vector of rates.

Implements Process.

◆ IsValid()

bool ProcessOutflowSnowHolding::IsValid ( ) const

nodiscardoverridevirtual

Check that everything is correctly defined.

Returns: true if everything is correctly defined.

Reimplemented from ProcessOutflow.

◆ RegisterProcessSettings()

void ProcessOutflowSnowHolding::RegisterProcessSettings ( SettingsModel * modelSettings )

static

Register the process parameters and forcing in the settings model.

Parameters

modelSettings The settings model to register the parameters in.

◆ SetParameters()

void ProcessOutflowSnowHolding::SetParameters ( const ProcessSettings & processSettings )

overridevirtual

Assign the parameters to the process.

Parameters

processSettings settings of the process containing the parameters.

Reimplemented from Process.

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

/github/workspace/core/src/processes/ProcessOutflowSnowHolding.h
/github/workspace/core/src/processes/ProcessOutflowSnowHolding.cpp

Public Member Functions

Static Public Member Functions