hydrobricks
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Flux Class Referenceabstract
Inheritance diagram for Flux:
FluxForcing FluxSimple FluxToAtmosphere FluxToBrick FluxToOutlet FluxToBrickInstantaneous

Public Member Functions

virtual bool IsOk ()=0
 
virtual void Reset ()
 
virtual double GetAmount ()=0
 
virtual void UpdateFlux (double amount)
 
void LinkChangeRate (double *rate)
 
double * GetChangeRatePointer ()
 
double * GetAmountPointer ()
 
virtual bool IsForcing ()
 
virtual bool IsInstantaneous ()
 
void SetAsStatic ()
 
bool IsStatic ()
 
bool NeedsWeighting ()
 
void NeedsWeighting (bool value)
 
void SetFractionUnitArea (double value)
 
void SetFractionLandCover (double value)
 
void UpdateFractionTotal ()
 
string GetType ()
 
void SetType (const string &type)
 

Protected Attributes

double m_amount
 
double * m_changeRate
 
bool m_static
 
bool m_needsWeighting
 
double m_fractionUnitArea
 
double m_fractionLandCover
 
double m_fractionTotal
 
Modifier * m_modifier
 
string m_type
 

Member Function Documentation

◆ GetAmount()

virtual double Flux::GetAmount ( )
pure virtual

Get the amount of water outgoing the flux.

Returns
the amount of water outgoing the flux

Implemented in FluxForcing, FluxSimple, FluxToAtmosphere, FluxToBrick, FluxToBrickInstantaneous, and FluxToOutlet.

◆ IsOk()

virtual bool Flux::IsOk ( )
pure virtual

Check that everything is correctly defined.

Returns
true is everything is correctly defined.

Implemented in FluxForcing, FluxSimple, FluxToAtmosphere, FluxToBrick, FluxToBrickInstantaneous, and FluxToOutlet.

◆ UpdateFlux()

void Flux::UpdateFlux ( double  amount)
virtual

Set the water amount of the flux.

Parameters
amountthe water amount of the flux.

Reimplemented in FluxSimple, FluxToBrick, and FluxToBrickInstantaneous.

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