Inheritance diagram for ProcessOutflowDirect:

Public Member Functions
	ProcessOutflowDirect (WaterContainer *container)

bool	IsValid () const override

Public Member Functions inherited from ProcessOutflow
	ProcessOutflow (WaterContainer *container)

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	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 bool	NeedsTargetBrickLinking () 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 void	SetTargetBrick (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
vecDouble	GetRates () override

Protected Member Functions inherited from Process
double	GetSumChangeRatesOtherProcesses () const

Additional Inherited Members
Protected Attributes inherited from Process
string	_name

WaterContainer *	_container

TimeMachine *	_timeMachine {nullptr}

std::vector< std::unique_ptr< Flux > >	_outputs

Member Function Documentation

◆ GetRates()

vecDouble ProcessOutflowDirect::GetRates ( )

overrideprotectedvirtual

Get the rates of the process.

Implements Process.

bool ProcessOutflowDirect::IsValid ( ) const

nodiscardoverridevirtual

Check that everything is correctly defined.

A direct outflow drains the whole container content, so it is incompatible with any sibling process drawing from the same container.

Reimplemented from ProcessOutflow.

void ProcessOutflowDirect::RegisterProcessSettings ( SettingsModel * modelSettings )

static

Register the process parameters and forcing in the settings model.

Parameters

modelSettings The settings model to register the parameters in.

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