ProcessOutflowSnowHoldingPrevah Class Reference

Inheritance diagram for ProcessOutflowSnowHoldingPrevah:

Public Member Functions
	ProcessOutflowSnowHoldingPrevah (WaterContainer *container)
bool	IsValid () const override
void	SetParameters (const ProcessSettings &processSettings) override
void	AttachForcing (Forcing *forcing) override
Public Member Functions inherited from ProcessOutflowSnowHolding
	ProcessOutflowSnowHolding (WaterContainer *container)
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
const float *	GetParameterValuePointer (const ProcessSettings &processSettings, std::string_view name)
void	SetParentContext (HydroUnit *unit, Brick *brick)
virtual void	SetHydroUnitProperties (HydroUnit *unit, Brick *brick)
void	AttachFluxOut (std::unique_ptr< Flux > flux)
int	GetOutputFluxCount () const
Flux *	GetOutputFlux (size_t index) const
virtual bool	ToAtmosphere () const
virtual bool	RequiresDailyTimeStep () const
virtual bool	NeedsTargetBrickLinking () const
virtual bool	NeedsGateBrickLinking () const
virtual bool	HasConstraintPriority () const
virtual const 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 void	AddGateBrick (Brick *)
virtual bool	LinksMultipleTargets () const
virtual void	AddTargetBrickWithWeights (Brick *, const std::vector< Brick * > &)
virtual bool	IsLateralProcess () const noexcept
virtual bool	HasLinearResponse () const
virtual double	GetLinearResponseRate () const
virtual double	GetLinearResponseOffset () const
bool	HasOutputFluxes () const noexcept
bool	HasWaterContainer () const noexcept

Static Public Member Functions
static void	RegisterProcessSettings (SettingsModel *modelSettings)
Static Public Member Functions inherited from ProcessOutflowSnowHolding
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)

Protected Member Functions
const vecDouble &	GetRates () override
ProcessMelt *	FindSiblingMeltProcess () const
double	GetMeltThisStep () const
Protected Member Functions inherited from ProcessOutflowSnowHolding
Protected Member Functions inherited from Process
double	GetForcingRate (Forcing *forcing) const
double	GetTimeStepInDays () const
int	GetCurrentDayOfYear () const
const vecDouble &	StoreRates (std::initializer_list< double > rates)
double	GetSumChangeRatesOtherProcesses () const

Protected Attributes
Forcing *	_temperature
const float *	_meltingTemperature
const float *	_liquidReleaseExponent {nullptr}
ProcessMelt *	_meltProcess {nullptr}
Protected Attributes inherited from ProcessOutflowSnowHolding
const float *	_waterHoldingCapacity
Protected Attributes inherited from Process
string	_name
WaterContainer *	_container
TimeMachine *	_timeMachine {nullptr}
HydroUnit *	_hydroUnit {nullptr}
string	_parentBrickName
std::vector< std::unique_ptr< Flux > >	_outputs
vecDouble	_changeRates

Member Function Documentation

AttachForcing()

void ProcessOutflowSnowHoldingPrevah::AttachForcing ( Forcing * forcing )

overridevirtual

Attach forcing to the process.

Parameters

forcing

forcing to attach.

Reimplemented from Process.

FindSiblingMeltProcess()

ProcessMelt * ProcessOutflowSnowHoldingPrevah::FindSiblingMeltProcess ( ) const

nodiscardprotected

Find the melt process on the same snowpack brick (any melt kind).

Returns

pointer to the sibling melt process, or nullptr if not found.

GetMeltThisStep()

double ProcessOutflowSnowHoldingPrevah::GetMeltThisStep ( ) const

nodiscardprotected

Get the melt water delivered to the snowpack liquid store this time step.

Returns

the melt amount M [mm], read from the sibling melt process' instantaneous output flux (0 if there is no melt process or no melt this step).

GetRates()

const vecDouble & ProcessOutflowSnowHoldingPrevah::GetRates ( )

overrideprotectedvirtual

Get the rates of the process.

Implementations must store their result via StoreRates() (or directly in the _changeRates buffer) and return the reference, to avoid allocating on the hot path.

Returns

reference to the reusable buffer holding the rates.

Reimplemented from ProcessOutflowSnowHolding.

IsValid()

bool ProcessOutflowSnowHoldingPrevah::IsValid ( ) const

nodiscardoverridevirtual

Check that everything is correctly defined.

Returns

true if everything is correctly defined.

Reimplemented from ProcessOutflowSnowHolding.

RegisterProcessSettings()

void ProcessOutflowSnowHoldingPrevah::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 ProcessOutflowSnowHoldingPrevah::SetParameters ( const ProcessSettings & processSettings )

overridevirtual

Assign the parameters to the process.

Parameters

processSettings

settings of the process containing the parameters.

Reimplemented from ProcessOutflowSnowHolding.

---

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

• /github/workspace/core/src/processes/ProcessOutflowSnowHoldingPrevah.h
• /github/workspace/core/src/processes/ProcessOutflowSnowHoldingPrevah.cpp