ProcessInfiltration Class Reference

Inheritance diagram for ProcessInfiltration:

Public Member Functions
	ProcessInfiltration (WaterContainer *container)
bool	IsValid () const override
bool	NeedsTargetBrickLinking () const override
int	GetConnectionCount () const override
double *	GetValuePointer (const string &name) override
void	SetTargetBrick (Brick *targetBrick) override
Public Member Functions inherited from Process
	Process (WaterContainer *container)
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)
WaterContainer *	GetWaterContainer () const
virtual bool	IsLateralProcess () const
bool	HasOutputFluxes () const
bool	HasWaterContainer () const

Protected Member Functions
double	GetTargetStock () const
double	GetTargetCapacity () const
double	GetTargetFillingRatio () const
Protected Member Functions inherited from Process
double	GetSumChangeRatesOtherProcesses () const
virtual vecDouble	GetRates ()=0

Protected Attributes
Brick *	_targetBrick
Protected Attributes inherited from Process
string	_name
WaterContainer *	_container
std::vector< std::unique_ptr< Flux > >	_outputs

Additional Inherited Members
Static Public Member Functions inherited from Process
static Process *	Factory (const ProcessSettings &processSettings, Brick *brick)
static bool	RegisterParametersAndForcing (SettingsModel *modelSettings, const string &processType)
static bool	HasParameter (const ProcessSettings &processSettings, const string &name)
static const float *	GetParameterValuePointer (const ProcessSettings &processSettings, const string &name)

Member Function Documentation

GetConnectionCount()

int ProcessInfiltration::GetConnectionCount ( ) const

overridevirtual

Get the number of connections to the process.

Returns

number of connections to the process.

Implements Process.

GetTargetCapacity()

double ProcessInfiltration::GetTargetCapacity ( ) const

protected

Get the maximum capacity of the target brick.

Returns

The maximum capacity of the target brick.

GetTargetFillingRatio()

double ProcessInfiltration::GetTargetFillingRatio ( ) const

protected

Get the filling ratio of the target brick.

Returns

The filling ratio of the target brick.

GetTargetStock()

double ProcessInfiltration::GetTargetStock ( ) const

protected

Get the water content of the target brick.

Returns

The water content of the target brick.

GetValuePointer()

double * ProcessInfiltration::GetValuePointer ( const string & name )

overridevirtual

Get the value pointer for a given element.

Parameters

name	name of the element to get.

Returns

pointer to the value of the given element.

Reimplemented from Process.

IsValid()

bool ProcessInfiltration::IsValid ( ) const

nodiscardoverridevirtual

Check that everything is correctly defined.

Returns

true if everything is correctly defined.

Implements Process.

NeedsTargetBrickLinking()

bool ProcessInfiltration::NeedsTargetBrickLinking ( ) const

inlinenodiscardoverridevirtual

Check if the process needs to link the target brick.

Returns

true if the process needs to link the target brick.

Reimplemented from Process.

SetTargetBrick()

void ProcessInfiltration::SetTargetBrick ( Brick * targetBrick )

inlineoverridevirtual

Set the target brick for the process.

Parameters

brick

target brick.

Reimplemented from Process.

---

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

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