PPS-25-flood-sim
API
Generated with
PPS-25-flood-sim/floodsim/floodsim.model/floodsim.model.cell/floodsim.model.cell.physics/DefaultWaterHeightCalculator

DefaultWaterHeightCalculator

floodsim.model.cell.physics.DefaultWaterHeightCalculator
object DefaultWaterHeightCalculator extends WaterHeightCalculator

Default implementation of the water height calculation that accounts for layered obstacles.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def calculate(dimensions: Double, waterVolume: Double, obstacles: Seq[Obstacle]): Double

Calculates the height of water in a cell based on cell dimensions, water volume, and obstacles.

Calculates the height of water in a cell based on cell dimensions, water volume, and obstacles.

Value parameters

dimensions

the dimensions of the cell

obstacles

the obstacles present in the cell

waterVolume

the volume of water in the cell

Attributes

Returns

the calculated height of the water

Generated with