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

#include <ProcessInfiltrationGR4J.h>

Inheritance diagram for ProcessInfiltrationGR4J:
ProcessInfiltration Process

Public Member Functions

 ProcessInfiltrationGR4J (WaterContainer *container)
 
- Public Member Functions inherited from ProcessInfiltration
 ProcessInfiltration (WaterContainer *container)
 
bool IsValid () const override
 
bool NeedsTargetBrickLinking () const override
 
int GetConnectionCount () const override
 
double * GetValuePointer (std::string_view name) override
 
void SetTargetBrick (Brick *targetBrick) 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 SetParameters (const ProcessSettings &processSettings)
 
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 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 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 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 ProcessInfiltration
double GetTargetStock () const
 
double GetTargetCapacity () const
 
double GetTargetFillingRatio () const
 
- Protected Member Functions inherited from Process
double GetSumChangeRatesOtherProcesses () const
 

Additional Inherited Members

- Protected Attributes inherited from ProcessInfiltration
Brick * _targetBrick
 
- Protected Attributes inherited from Process
string _name
 
WaterContainer * _container
 
TimeMachine * _timeMachine {nullptr}
 
std::vector< std::unique_ptr< Flux > > _outputs
 

Detailed Description

GR4J production-store infiltration (Ps).

Reads net precipitation Pn directly from the container (ground_soil brick, which receives only Pn via the instantaneous throughfall from the ground land-cover brick) and computes the portion entering the production store: Ps = X1 × (1 − (S/X1)²) × tanh(Pn/X1) / (1 + (S/X1) × tanh(Pn/X1))

Requires a linked target brick (production_store) to read its current filling ratio and capacity (X1). No forcing needed.

Member Function Documentation

◆ GetRates()

vecDouble ProcessInfiltrationGR4J::GetRates ( )
overrideprotectedvirtual

Get the rates of the process.

Returns
vector of rates.

Implements Process.

◆ RegisterProcessSettings()

void ProcessInfiltrationGR4J::RegisterProcessSettings ( SettingsModel * modelSettings)
static

Register the process parameters and forcing in the settings model.

Parameters
modelSettingsThe settings model to register the parameters in.
The documentation for this class was generated from the following files: