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

Public Member Functions

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

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 FluxToBrick::GetAmount ( )
overridevirtual

Get the amount of water outgoing the flux.

Returns
the amount of water outgoing the flux

Implements Flux.

Reimplemented in FluxToBrickInstantaneous.

◆ GetTargetBrick()

Brick * FluxToBrick::GetTargetBrick ( ) const
inline

Get the target brick of the flux.

Returns
pointer to the target brick.

◆ IsOk()

bool FluxToBrick::IsOk ( )
overridevirtual

Check that everything is correctly defined.

Returns
true is everything is correctly defined.

Implements Flux.

Reimplemented in FluxToBrickInstantaneous.

◆ UpdateFlux()

void FluxToBrick::UpdateFlux ( double amount)
overridevirtual

Set the water amount of the flux.

Parameters
amountthe water amount of the flux.

Reimplemented from Flux.

Reimplemented in FluxToBrickInstantaneous.


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