hydrobricks
Loading...
Searching...
No Matches
WaterContainer Class Reference
Inheritance diagram for WaterContainer:
IceContainer SnowContainer

Public Member Functions

 WaterContainer (Brick *brick)
 
virtual bool IsOk ()
 
void SubtractAmountFromDynamicContentChange (double change)
 
void AddAmountToDynamicContentChange (double change)
 
void AddAmountToStaticContentChange (double change)
 
virtual void ApplyConstraints (double timeSte)
 
void SetOutgoingRatesToZero ()
 
void Finalize ()
 
void Reset ()
 
void SaveAsInitialState ()
 
vecDoublePt GetDynamicContentChanges ()
 
bool HasMaximumCapacity () const
 
double GetMaximumCapacity ()
 
void SetMaximumCapacity (float *value)
 
void SetAsInfiniteStorage ()
 
double GetContentWithChanges () const
 
double GetContentWithDynamicChanges () const
 
double GetContentWithoutChanges () const
 
double * GetContentPointer ()
 
void SetInitialState (double value)
 
void UpdateContent (double value)
 
double GetTargetFillingRatio ()
 
bool IsNotEmpty ()
 
bool HasOverflow ()
 
void LinkOverflow (Process *overflow)
 
void AttachFluxIn (Flux *flux)
 
virtual double SumIncomingFluxes ()
 
virtual bool ContentAccessible () const
 
BrickGetParentBrick ()
 

Member Function Documentation

◆ AddAmountToDynamicContentChange()

void WaterContainer::AddAmountToDynamicContentChange ( double change)

Add the amount of water to the dynamic content change.

Parameters
changeamount to add [mm]

◆ AddAmountToStaticContentChange()

void WaterContainer::AddAmountToStaticContentChange ( double change)

Add the amount of water to the static content change.

Parameters
changeamount to add [mm]

◆ ApplyConstraints()

void WaterContainer::ApplyConstraints ( double timeSte)
virtual

Apply the constraints to the water container.

Parameters
timeStetime step [s]

Reimplemented in IceContainer.

◆ AttachFluxIn()

void WaterContainer::AttachFluxIn ( Flux * flux)
inline

Attach incoming flux.

Parameters
fluxincoming flux

◆ ContentAccessible()

bool WaterContainer::ContentAccessible ( ) const
virtual

Check if the water content is accessible.

Reimplemented in IceContainer.

◆ Finalize()

void WaterContainer::Finalize ( )

Finalize the water container computation.

◆ GetContentPointer()

double * WaterContainer::GetContentPointer ( )
inline

Get the water content value pointer.

Returns
pointer to the water content value

◆ GetContentWithChanges()

double WaterContainer::GetContentWithChanges ( ) const
inline

Get the water content of the current object.

Returns
water content [mm]

◆ GetContentWithDynamicChanges()

double WaterContainer::GetContentWithDynamicChanges ( ) const
inline

Get the water content of the current object with dynamic changes.

Returns
water content [mm]

◆ GetContentWithoutChanges()

double WaterContainer::GetContentWithoutChanges ( ) const
inline

Get the water content of the current object without changes.

Returns
water content [mm]

◆ GetDynamicContentChanges()

vecDoublePt WaterContainer::GetDynamicContentChanges ( )

Get the dynamic content changes.

Returns
dynamic content changes [mm]

◆ GetMaximumCapacity()

double WaterContainer::GetMaximumCapacity ( )
inline

Get the maximum capacity of the water container.

Returns
maximum capacity [mm]

◆ GetParentBrick()

Brick * WaterContainer::GetParentBrick ( )
inline

Get the parent brick of the water container.

Returns
pointer to the parent brick

◆ GetTargetFillingRatio()

double WaterContainer::GetTargetFillingRatio ( )

Get the filling ratio of the water container.

Returns
filling ratio [0-1]

◆ HasMaximumCapacity()

bool WaterContainer::HasMaximumCapacity ( ) const
inline

Check if the water container has a maximum capacity.

Returns
true if the water container has a maximum capacity, false otherwise

◆ HasOverflow()

bool WaterContainer::HasOverflow ( )
inline

Check if the water container has an overflow process.

Returns
true if the water container has an overflow process, false otherwise

◆ IsNotEmpty()

bool WaterContainer::IsNotEmpty ( )
inline

Check if the water container is not empty.

Returns
true if the water container is not empty, false otherwise

◆ IsOk()

bool WaterContainer::IsOk ( )
virtual

Check if the water container is ok.

◆ LinkOverflow()

void WaterContainer::LinkOverflow ( Process * overflow)
inline

Link the water container to an overflow process.

Parameters
overflowpointer to the overflow process

◆ Reset()

void WaterContainer::Reset ( )

Reset the water container to its initial state.

◆ SaveAsInitialState()

void WaterContainer::SaveAsInitialState ( )

Save the initial state of the water container.

◆ SetAsInfiniteStorage()

void WaterContainer::SetAsInfiniteStorage ( )
inline

Set the water container as an infinite storage.

◆ SetInitialState()

void WaterContainer::SetInitialState ( double value)
inline

Set the initial state of the water container.

Parameters
valueinitial state [mm]

◆ SetMaximumCapacity()

void WaterContainer::SetMaximumCapacity ( float * value)
inline

Set the maximum capacity of the water container.

Parameters
valuemaximum capacity [mm]

◆ SetOutgoingRatesToZero()

void WaterContainer::SetOutgoingRatesToZero ( )

Set the outgoing rates to zero.

◆ SubtractAmountFromDynamicContentChange()

void WaterContainer::SubtractAmountFromDynamicContentChange ( double change)

Subtract the amount of water from the dynamic content change.

Parameters
changeamount to subtract [mm]

◆ SumIncomingFluxes()

double WaterContainer::SumIncomingFluxes ( )
virtual

Sums the water amount from the different fluxes.

Returns
sum of the water amount [mm]

◆ UpdateContent()

void WaterContainer::UpdateContent ( double value)
inline

Update the content of the water container.

Parameters
valuenew content [mm]

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