Inheritance diagram for FluxSimple:

Public Member Functions
bool	IsValid () const override

double	GetAmount () override

void	UpdateFlux (double amount) override

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

virtual void	Reset ()

void	LinkChangeRate (double *rate)

double *	GetChangeRatePointer ()

double *	GetAmountPointer ()

virtual bool	IsForcing () const

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

Additional Inherited Members
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

◆ GetAmount()

double FluxSimple::GetAmount ( )

overridevirtual

Get the amount of water outgoing the flux.

Implements Flux.

bool FluxSimple::IsValid ( ) const

nodiscardoverridevirtual

Check that everything is correctly defined.

Implements Flux.

void FluxSimple::UpdateFlux ( double amount )

overridevirtual

Set the water amount of the flux.

Parameters

amount the water amount of the flux.

Reimplemented from Flux.

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