rs2.modeler.properties.material.hydraulic.StaticGroundwater module

class rs2.modeler.properties.material.hydraulic.StaticGroundwater.StaticGroundwaterStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getPiezoToUse() → str

getGridToUse() → str

class rs2.modeler.properties.material.hydraulic.StaticGroundwater.StaticGroundwaterDefinedStageFactor(client: Client, ID, propertyID)

Bases: StaticGroundwaterStageFactor

setPiezoToUse(piezoName: str)

setGridToUse(gridName: str)

class rs2.modeler.properties.material.hydraulic.StaticGroundwater.StaticGroundwater(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Variables:

stageFactorInterface (AbsoluteStageFactorGettersInterface[StaticGroundwaterDefinedStageFactor, StaticGroundwaterStageFactor]) – Reference object for modifying stage factor property.

Examples

Code Snippet: Manipulation of Hydraulic Static Groundwater Properties

getStaticWaterMode() → StaticWaterModes

setStaticWaterMode(value: StaticWaterModes)

getStaticPoreWaterPressure() → float

setStaticPoreWaterPressure(value: float)

getRuValue() → float

setRuValue(value: float)

getHuType() → HuTypes

setHuType(value: HuTypes)

getHuValue() → float

setHuValue(value: float)

setPiezoToUse(piezoName: str)

piezoName is the id of the piezo line to be used or “None”.

getPiezoToUse() → str

Returns the id of the piezo line to be used or “None”.

setGridToUse(gridName: str)

gridName is the name of the grid to be used. “None” and “Default Grid” are available by default.

getGridToUse() → str

setProperties(StaticWaterMode: StaticWaterModes = None, StaticPoreWaterPressure: float = None, RuValue: float = None, HuType: HuTypes = None, HuValue: float = None)

getProperties()