hydrobricks
Loading...
Searching...
No Matches
Public Member Functions | List of all members
InterceptionStorage Class Reference

#include <InterceptionStorage.h>

Inheritance diagram for InterceptionStorage:
SurfaceComponent Brick

Public Member Functions

void SetParameters (const BrickSettings &brickSettings) override
 
- Public Member Functions inherited from SurfaceComponent
bool CanHaveAreaFraction () const override
 
double GetAreaFraction () const
 
void SetAreaFraction (double value)
 
double GetParentAreaFraction () const
 
bool IsNull () const override
 
bool HasParent () const
 
LandCover * GetParent () const
 
virtual void SetParent (LandCover *parent)
 
- Public Member Functions inherited from Brick
virtual void AttachFluxIn (Flux *flux)
 
virtual void AttachFluxIn (std::unique_ptr< Flux > flux)
 
void AddProcess (std::unique_ptr< Process > process)
 
virtual void Reset ()
 
virtual void SaveAsInitialState ()
 
virtual bool IsValid (bool checkProcesses=true) const
 
virtual void Validate () const
 
bool NeedsSolver () const
 
void SetNeedsSolver (bool needsSolver)
 
BrickCategory GetCategory () const
 
virtual bool IsLandCover () const
 
bool HasProcesses () const
 
bool HasHydroUnit () const
 
virtual void Finalize ()
 
virtual void SetInitialState (double value, ContentType type)
 
virtual double GetContent (ContentType type) const
 
virtual void UpdateContent (double value, ContentType type)
 
virtual void UpdateContentFromInputs ()
 
virtual void ApplyConstraints (double timeStep)
 
WaterContainer * GetWaterContainer () const
 
size_t GetProcessCount () const noexcept
 
Process * GetProcess (size_t index) const
 
const string & GetName () const noexcept
 
void SetName (std::string_view name)
 
HydroUnit * GetHydroUnit () const
 
void SetHydroUnit (HydroUnit *hydroUnit)
 
virtual vecDoublePt GetDynamicContentChanges ()
 
vecDoublePt GetStateVariableChangesFromProcesses ()
 
int GetProcessConnectionCount () const
 
double * GetBaseValuePointer (std::string_view name)
 
virtual double * GetValuePointer (std::string_view name)
 

Additional Inherited Members

- Static Public Member Functions inherited from Brick
static std::unique_ptr< Brick > Factory (const BrickSettings &brickSettings)
 
static std::unique_ptr< Brick > Factory (BrickType type)
 
static bool HasParameter (const BrickSettings &brickSettings, std::string_view name)
 
static const float * GetParameterValuePointer (const BrickSettings &brickSettings, std::string_view name)
 
- Protected Attributes inherited from SurfaceComponent
LandCover * _parent
 
double _areaFraction
 
- Protected Attributes inherited from Brick
string _name
 
bool _needsSolver
 
BrickCategory _category
 
std::unique_ptr< WaterContainer > _water
 
std::vector< std::unique_ptr< Process > > _processes
 
HydroUnit * _hydroUnit
 

Detailed Description

Interception storage (e.g. a forest canopy).

A surface component (so its area follows the parent land cover fraction) that holds water up to a capacity. It is meant to sit on the rain path upstream of the snowpack: it evaporates at the potential rate (et:open_water) and releases the excess over the capacity as throughfall (overflow). Being a surface component, its content and ET weight by the parent cover's area fraction, so the catchment water balance closes when the cover fraction is below one.

Member Function Documentation

◆ SetParameters()

void InterceptionStorage::SetParameters ( const BrickSettings & brickSettings)
overridevirtual

Assign the parameters to the brick element.

Parameters
brickSettingssettings of the brick containing the parameters.

Reimplemented from Brick.

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