Inheritance diagram for FluxToBrickInstantaneous:

Public Member Functions
	FluxToBrickInstantaneous (Brick *brick)

bool	IsValid () const override

bool	IsInstantaneous () const override

double	GetAmount () override

double	GetRealAmount () const

void	UpdateFlux (double amount) override

Public Member Functions inherited from FluxToBrick
	FluxToBrick (Brick *brick)

Brick *	GetTargetBrick () const

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

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 FluxToBrick
Brick *	_toBrick

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 FluxToBrickInstantaneous::GetAmount ( )

overridevirtual

Get the amount of water outgoing the flux.

Reimplemented from FluxToBrick.

double FluxToBrickInstantaneous::GetRealAmount ( ) const

Get the real amount of water that has been transferred to the brick.

bool FluxToBrickInstantaneous::IsInstantaneous ( ) const

inlineoverridevirtual

Check if the flux is instantaneous.

Reimplemented from Flux.

bool FluxToBrickInstantaneous::IsValid ( ) const

nodiscardoverridevirtual

Check that everything is correctly defined.

Reimplemented from FluxToBrick.

void FluxToBrickInstantaneous::UpdateFlux ( double amount )

overridevirtual

Set the water amount of the flux.

Parameters

amount the water amount of the flux.

Reimplemented from FluxToBrick.

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