hydrobricks
Loading...
Searching...
No Matches
FluxSimple Class Reference
Inheritance diagram for FluxSimple:
Flux

Public Member Functions

bool IsOk () override
 
double GetAmount () override
 
void UpdateFlux (double amount) override
 
- Public Member Functions inherited from Flux
virtual void Reset ()
 
void LinkChangeRate (double *rate)
 
double * GetChangeRatePointer ()
 
double * GetAmountPointer ()
 
virtual bool IsForcing ()
 
virtual bool IsInstantaneous ()
 
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)
 

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.

Returns
the amount of water outgoing the flux

Implements Flux.

◆ IsOk()

bool FluxSimple::IsOk ( )
nodiscardoverridevirtual

Check that everything is correctly defined.

Returns
true is everything is correctly defined.

Implements Flux.

◆ UpdateFlux()

void FluxSimple::UpdateFlux ( double amount)
overridevirtual

Set the water amount of the flux.

Parameters
amountthe water amount of the flux.

Reimplemented from Flux.


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