ProcessRunoffSocont Class Reference

#include <ProcessRunoffSocont.h>

Inheritance diagram for ProcessRunoffSocont:

Public Member Functions
	ProcessRunoffSocont (WaterContainer *container)
void	SetHydroUnitProperties (HydroUnit *unit, Brick *brick) override
void	SetParameters (const ProcessSettings &processSettings) override
Public Member Functions inherited from ProcessOutflow
	ProcessOutflow (WaterContainer *container)
bool	IsValid () const override
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	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 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 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
const vecDouble &	GetRates () override
double	GetArea () const
Protected Member Functions inherited from Process
const vecDouble &	StoreRates (std::initializer_list< double > rates)
double	GetSumChangeRatesOtherProcesses () const

Protected Attributes
float	_slope
const float *	_beta
double *	_areaFraction
double	_areaUnit
double	_exponent
Protected Attributes inherited from Process
string	_name
WaterContainer *	_container
TimeMachine *	_timeMachine {nullptr}
std::vector< std::unique_ptr< Flux > >	_outputs
vecDouble	_changeRates

Detailed Description

Socont surface runoff (kinematic-wave overland flow on an inclined plane).

Treats the storage as a thin water layer flowing down a plane of given slope, with a linear depth profile (zero at the top, h at the bottom; storage shape = 2). The outflow follows a Manning-type relation: q = beta × slope^0.5 × h^(5/3) / area integrated over the timestep and capped at the available content. beta lumps the roughness and geometry; the slope is read from the hydro unit.

Member Function Documentation

GetArea()

double ProcessRunoffSocont::GetArea ( ) const

nodiscardprotected

Get the area of the hydro unit.

Returns

The area of the hydro unit [m²]

GetRates()

const vecDouble & ProcessRunoffSocont::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.

Implements Process.

RegisterProcessSettings()

void ProcessRunoffSocont::RegisterProcessSettings ( SettingsModel * modelSettings )

static

Register the process parameters and forcing in the settings model.

Parameters

modelSettings

The settings model to register the parameters in.

SetHydroUnitProperties()

void ProcessRunoffSocont::SetHydroUnitProperties ( HydroUnit * unit, Brick * brick )

overridevirtual

Set the properties of the hydro unit.

Parameters

unit	the related hydro unit.
brick	the related brick.

Reimplemented from Process.

SetParameters()

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