rs3.properties.material.hydraulic.WaterConditions module#

class rs3.properties.material.hydraulic.WaterConditions.WaterConditionsBase(client: Client, id: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getStaticHuValue() → float#
setStaticHuValue(value: float)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(StaticHuValue: float = None)#

Set properties using keyword arguments.

class rs3.properties.material.hydraulic.WaterConditions.WaterConditions(client: Client, id: str)#

Bases: WaterConditionsBase

Examples

See Material Hydraulic Script Examples.

setStaticHuType(value: HuTypes)#
getStaticHuType() → HuTypes#
createNewWaterCondition(waterConditionName: str, userDefinedType: HydraulicParameterType, value: float) → None#

Create a new water condition entry with the specified name, parameter type, and value for the current material.

Parameters:

  • waterConditionName (str) – The name of the new water condition (e.g., “Pore Water Pressure 1”).

  • userDefinedType (HydraulicParameterType) – The type of hydraulic parameter (e.g. PWP or Ru) to associate with this water condition

  • value (float) – The numerical value associated with the water condition.

deleteWaterCondition(waterConditionName: str) → None#

Delete an existing water condition for the current material.

After deletion, the material’s water condition will default to DRY.

Parameters:

waterConditionName (str) – The name of the water condition to delete (e.g., “Pore Water Pressure 1”).

getWaterConditionPropertyByName(waterConditionName: str) → PhreaticConditions#
getWaterConditionProperties() → list[PhreaticConditions]#
setWaterConditions(waterType: StaticWaterModes, name: str = '')#

Set the default water condition in phreatic surface method and initial water condition in the steady state or trainsient state methods of the current material.

This defines the starting water condition used in hydraulic calculations.

  • If waterType is DRY, no name is required.

  • If waterType refers to a water surface, PWP interpolation surface, or PWP point set, the name must match an existing water table.

  • If waterType is USER_DEFINED_VALUE, the name must match an existing user-defined pore water pressure (PWP) or Ru entry.

Parameters:

  • waterType (WaterConditionWaterType) – The type of water condition to set.

  • name (str, optional) – The name of the water table, PWP dataset, or user-defined PWP to use. Required for all types except DRY. Defaults to an empty string.

Raises:

ValueError – If name is required for the given waterType but is not provided.

getWaterConditions() → str#

Retrieve the name of the current default water condition in phreatic surface method and initial water condition in the steady state or trainsient state methods of the current material.

Returns:

The name of the initial water condition or “Dry” if the waterType is DRY.

Return type:

str