Inheritance diagram for FluxForcing:

Public Member Functions
bool	IsValid () const override

double	GetAmount () override

void	AttachForcing (Forcing *forcing)

bool	IsForcing () const override

Public Member Functions inherited from Flux
virtual void	Validate () const

virtual void	Reset ()

virtual void	UpdateFlux (double amount)

void	LinkChangeRate (double *rate)

double *	GetChangeRatePointer ()

double *	GetAmountPointer ()

virtual bool	IsInstantaneous () const

void	SetAsStatic ()

bool	IsStatic () const

bool	NeedsWeighting () const

void	NeedsWeighting (bool value)

void	SetFractionUnitArea (double value)

void	SetFractionLandCover (double value)

void	UpdateFractionTotal ()

ContentType	GetType () const

void	SetType (const ContentType type)

bool	HasChangeRate () const

bool	HasModifier () const

Protected Attributes
Forcing *	_forcing

Protected Attributes inherited from Flux
double	_amount {}

double *	_changeRate {}

bool	_static {}

bool	_needsWeighting {}

double	_fractionUnitArea {1.0}

double	_fractionLandCover {1.0}

double	_fractionTotal {1.0}

Modifier *	_modifier {}

ContentType	_type {ContentType::Water}

Member Function Documentation

◆ AttachForcing()

void FluxForcing::AttachForcing ( Forcing * forcing )

Attach a forcing to the flux.

Parameters

forcing the forcing to attach.

double FluxForcing::GetAmount ( )

overridevirtual

Get the amount of water outgoing the flux.

Implements Flux.

bool FluxForcing::IsForcing ( ) const

inlineoverridevirtual

Check if the flux is a forcing.

Reimplemented from Flux.

bool FluxForcing::IsValid ( ) const

nodiscardoverridevirtual

Check that everything is correctly defined.

Implements Flux.

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