AbsorptionRate

floodsim.model.cell.AbsorptionRate

Represents the rate at which a cell can absorb water. This is implemented as an opaque type to encapsulate absorption rate values and provide controlled access through extension methods.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Types

opaque type AbsorptionRate

Value members

Concrete methods

def apply(value: Double): AbsorptionRate

Creates a new absorption rate with the specified value.

Creates a new absorption rate with the specified value.

Value parameters

value

the absorption rate value

Attributes

Returns

a new AbsorptionRate instance

Extensions

Extensions

extension (rate: AbsorptionRate)
def decrease(amount: Double): AbsorptionRate

Decreases the absorption rate by the specified amount.

Decreases the absorption rate by the specified amount.

Value parameters

amount

the amount to decrease the absorption rate by

Attributes

Returns

a new AbsorptionRate with the decreased value (minimum 0.0)

def value: Double

Returns the underlying value of the absorption rate.

Returns the underlying value of the absorption rate.

Attributes

Returns

the absorption rate as a Double