rs3.properties.material.hydraulic.StaticGroundwater module#

class rs3.properties.material.hydraulic.StaticGroundwater.StaticGroundwaterStageFactor(id: str, stageFactorID: str, client: Client)#

Bases: IStageFactorBase

Examples

See Material Hydraulic Script Examples.

getWaterCondition() → 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 for each stage.

Returns:

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

Return type:

str

class rs3.properties.material.hydraulic.StaticGroundwater.StaticGroundwaterDefinedStageFactor(id: str, stageFactorID: str, client: Client)#

Bases: StaticGroundwaterStageFactor

Examples

Material Hydraulic Script Examples

setWaterCondition(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 for each stage.

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.

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

Bases: WaterConditions

Examples

See Material Hydraulic Script Examples.

getStaticWaterModeByName(waterConditionName: str) → PhreaticConditions#
getAllStaticWaterModes() → list[PhreaticConditions]#
setStaticWaterMode(waterType: StaticWaterModes, name: str = '')#

Set the default water condition in phreatic surface method 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.

getStaticWaterMode() → str#

Retrieve the name of the current default water condition in phreatic surface method of the current material.

Returns:

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

Return type:

str