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

Public Member Functions

bool IsValid () const override
 
double GetAmount () 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 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 FluxToOutlet::GetAmount ( )
overridevirtual

Get the amount of water outgoing the flux.

Returns
the amount of water outgoing the flux

Implements Flux.

◆ IsValid()

bool FluxToOutlet::IsValid ( ) const
nodiscardoverridevirtual

Check that everything is correctly defined.

Returns
true if everything is correctly defined.

Implements Flux.


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