ProcessInfiltration Class Reference

Inheritance diagram for ProcessInfiltration:

Public Member Functions
	ProcessInfiltration (WaterContainer *container)
bool	IsOk () override
bool	NeedsTargetBrickLinking () override
int	GetConnectionsNb () 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	SetHydroUnitProperties (HydroUnit *unit, Brick *brick)
virtual void	SetParameters (const ProcessSettings &processSettings)
virtual void	AttachForcing (Forcing *)
void	AttachFluxOut (Flux *flux)
vector< Flux * >	GetOutputFluxes ()
int	GetOutputFluxesNb ()
virtual bool	ToAtmosphere ()
virtual vecDouble	GetChangeRates ()
virtual void	StoreInOutgoingFlux (double *rate, int index)
void	ApplyChange (int connectionIndex, double rate, double timeStepInDays)
virtual void	Finalize ()
virtual vecDoublePt	GetStateVariables ()
string	GetName ()
void	SetName (const string &name)
WaterContainer *	GetWaterContainer ()

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

Protected Attributes
Brick *	m_targetBrick
Protected Attributes inherited from Process
string	m_name
WaterContainer *	m_container
vector< Flux * >	m_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 float *	GetParameterValuePointer (const ProcessSettings &processSettings, const string &name)

Member Function Documentation

GetConnectionsNb()

int ProcessInfiltration::GetConnectionsNb ( )

overridevirtual

Get the number of connections to the process.

Returns

number of connections to the process.

Implements Process.

GetTargetCapacity()

double ProcessInfiltration::GetTargetCapacity ( )

protected

Get the maximum capacity of the target brick.

Returns

The maximum capacity of the target brick.

GetTargetFillingRatio()

double ProcessInfiltration::GetTargetFillingRatio ( )

protected

Get the filling ratio of the target brick.

Returns

The filling ratio of the target brick.

GetTargetStock()

double ProcessInfiltration::GetTargetStock ( )

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.

IsOk()

bool ProcessInfiltration::IsOk ( )

overridevirtual

Check that everything is correctly defined.

Returns

true is everything is correctly defined.

Implements Process.

NeedsTargetBrickLinking()

bool ProcessInfiltration::NeedsTargetBrickLinking ( )

inlineoverridevirtual

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