|
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 |
|
◆ GetAmount()
virtual double Flux::GetAmount |
( |
| ) |
|
|
pure virtual |
◆ GetAmountPointer()
double * Flux::GetAmountPointer |
( |
| ) |
|
|
inline |
Get the amount of water outgoing the flux.
- Returns
- the amount of water outgoing the flux
◆ GetChangeRatePointer()
double * Flux::GetChangeRatePointer |
( |
| ) |
|
|
inline |
Get the change rate value pointer.
- Returns
- the change rate value pointer.
◆ GetType()
Get the flux type.
- Returns
- the flux type.
◆ IsForcing()
virtual bool Flux::IsForcing |
( |
| ) |
|
|
inlinevirtual |
Check if the flux is a forcing.
- Returns
- true if the flux is a forcing.
Reimplemented in FluxForcing.
◆ IsInstantaneous()
virtual bool Flux::IsInstantaneous |
( |
| ) |
|
|
inlinevirtual |
Check if the flux is instantaneous.
- Returns
- true if the flux is instantaneous.
Reimplemented in FluxToBrickInstantaneous.
◆ IsOk()
virtual bool Flux::IsOk |
( |
| ) |
|
|
pure virtual |
◆ IsStatic()
Check if the flux is static.
- Returns
- true if the flux is static.
◆ LinkChangeRate()
void Flux::LinkChangeRate |
( |
double * | rate | ) |
|
|
inline |
Link the flux to a change rate value pointer.
- Parameters
-
rate | the change rate value pointer. |
◆ NeedsWeighting() [1/2]
bool Flux::NeedsWeighting |
( |
| ) |
|
|
inline |
Check if the flux needs weighting.
- Returns
- true if the flux needs weighting.
◆ NeedsWeighting() [2/2]
void Flux::NeedsWeighting |
( |
bool | value | ) |
|
|
inline |
Set the flux as needing weighting.
- Parameters
-
value | true if the flux needs weighting. |
◆ Reset()
Reset the flux to its initial state.
◆ SetAsStatic()
void Flux::SetAsStatic |
( |
| ) |
|
|
inline |
◆ SetFractionLandCover()
void Flux::SetFractionLandCover |
( |
double | value | ) |
|
|
inline |
Set the fraction of the land cover.
- Parameters
-
value | the fraction of the land cover. |
◆ SetFractionUnitArea()
void Flux::SetFractionUnitArea |
( |
double | value | ) |
|
|
inline |
Get the fraction of the unit area.
- Returns
- the fraction of the unit area.
◆ SetType()
void Flux::SetType |
( |
const string & | type | ) |
|
|
inline |
Set the flux type.
- Parameters
-
◆ UpdateFlux()
void Flux::UpdateFlux |
( |
double | amount | ) |
|
|
virtual |
◆ UpdateFractionTotal()
void Flux::UpdateFractionTotal |
( |
| ) |
|
|
inline |
Update the fraction total.
The documentation for this class was generated from the following files:
- /github/workspace/core/src/fluxes/Flux.h
- /github/workspace/core/src/fluxes/Flux.cpp