hydrobricks
Loading...
Searching...
No Matches
Public Member Functions | List of all members
IceContainer Class Reference
Inheritance diagram for IceContainer:
WaterContainer

Public Member Functions

 IceContainer (Brick *brick)
 
void ApplyConstraints (double timeStep) override
 
void SetNoMeltWhenSnowCover (const float *value)
 
void SetRelatedSnowpack (Snowpack *snowpack)
 
bool ContentAccessible () const override
 
- Public Member Functions inherited from WaterContainer
 WaterContainer (Brick *brick)
 
virtual bool IsOk ()
 
void SubtractAmountFromDynamicContentChange (double change)
 
void AddAmountToDynamicContentChange (double change)
 
void AddAmountToStaticContentChange (double change)
 
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 ()
 
Brick * GetParentBrick ()
 

Member Function Documentation

◆ ApplyConstraints()

void IceContainer::ApplyConstraints ( double timeStep)
overridevirtual

Apply the constraints to the water container.

Parameters
timeStetime step [s]

Reimplemented from WaterContainer.

◆ ContentAccessible()

bool IceContainer::ContentAccessible ( ) const
overridevirtual

Check if the water content is accessible.

Reimplemented from WaterContainer.

◆ SetNoMeltWhenSnowCover()

void IceContainer::SetNoMeltWhenSnowCover ( const float * value)
inline

Set the option to not melt when snow cover is present.

Parameters
valuePointer to a float value. If the value is greater than 0, melting is disabled when snow cover is present.

◆ SetRelatedSnowpack()

void IceContainer::SetRelatedSnowpack ( Snowpack * snowpack)
inline

Set the related snowpack.

Parameters
snowpackPointer to a Snowpack object. This is used to check if there is snow cover present.
The documentation for this class was generated from the following files: