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

Public Member Functions

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

Forcingm_forcing
 
- Protected Attributes inherited from Flux
double m_amount
 
double * m_changeRate
 
bool m_static
 
bool m_needsWeighting
 
double m_fractionUnitArea
 
double m_fractionLandCover
 
double m_fractionTotal
 
Modifierm_modifier
 
string m_type
 

Member Function Documentation

◆ GetAmount()

double FluxForcing::GetAmount ( )
overridevirtual

Get the amount of water outgoing the flux.

Returns
the amount of water outgoing the flux

Implements Flux.

◆ IsForcing()

bool FluxForcing::IsForcing ( )
inlineoverridevirtual

Reimplemented from Flux.

◆ IsOk()

bool FluxForcing::IsOk ( )
overridevirtual

Check that everything is correctly defined.

Returns
true is everything is correctly defined.

Implements Flux.


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