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

Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from FluxToBrick
Brick_toBrick
 
- Protected Attributes inherited from Flux
double _amount
 
double * _changeRate
 
bool _static
 
bool _needsWeighting
 
double _fractionUnitArea
 
double _fractionLandCover
 
double _fractionTotal
 
Modifier_modifier
 
string _type
 

Member Function Documentation

◆ GetAmount()

double FluxToBrickInstantaneous::GetAmount ( )
overridevirtual

Get the amount of water outgoing the flux.

Returns
the amount of water outgoing the flux

Reimplemented from FluxToBrick.

◆ GetRealAmount()

double FluxToBrickInstantaneous::GetRealAmount ( )

Get the real amount of water that has been transferred to the brick.

Returns
The real amount of water that has been transferred to the brick.

◆ IsInstantaneous()

bool FluxToBrickInstantaneous::IsInstantaneous ( )
inlineoverridevirtual

Check if the flux is instantaneous.

Returns
true if the flux is instantaneous.

Reimplemented from Flux.

◆ IsOk()

bool FluxToBrickInstantaneous::IsOk ( )
overridevirtual

Check that everything is correctly defined.

Returns
true is everything is correctly defined.

Reimplemented from FluxToBrick.

◆ UpdateFlux()

void FluxToBrickInstantaneous::UpdateFlux ( double amount)
overridevirtual

Set the water amount of the flux.

Parameters
amountthe water amount of the flux.

Reimplemented from FluxToBrick.


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