HydraulicProperties

class HydraulicModelMode(*values)

Bases: Enum

SIMPLE = 1

FREDLUND = 2

VAN_GENUCHTEN = 3

BROOK = 4

USER_DEFINED = 5

GARDNER = 6

class HydraulicSimpleSoilType(*values)

Bases: Enum

GENERAL = 1

SAND = 2

SILT = 3

CLAY = 4

LOAM = 5

class HydraulicProperties(model_id: str, material_id: str, client: Client)

Bases: object

Examples: Code Snippet: Hydraulic Properties

Groundwater / FEA Hydraulic Properties for a material (permeability model, SWCC parameters, and optional spatial variability). Matches the Hydraulic Properties material tab in Slide2.

getHydraulicModelMode() → HydraulicModelMode

setHydraulicModelMode(mode: HydraulicModelMode) → None

getUserDefinedIndex() → int

Index into project user-defined water methods when mode is HydraulicModelMode.USER_DEFINED.

setUserDefinedIndex(index: int) → None

getKRatio() → float

setKRatio(value: float) → None

getKAngle() → float

Permeability direction angle (degrees).

setKAngle(value: float) → None

getKs() → float

Saturated hydraulic conductivity Ks.

setKs(value: float) → None

getFredlundA() → float

setFredlundA(value: float) → None

getFredlundB() → float

setFredlundB(value: float) → None

getFredlundC() → float

setFredlundC(value: float) → None

getVanGenuchtenAlpha() → float

setVanGenuchtenAlpha(value: float) → None

getVanGenuchtenN() → float

setVanGenuchtenN(value: float) → None

getVanGenuchtenM() → float

setVanGenuchtenM(value: float) → None

getVanGenuchtenUseCustomM() → bool

setVanGenuchtenUseCustomM(value: bool) → None

getBrookCoreyPoreSizeIndex() → float

setBrookCoreyPoreSizeIndex(value: float) → None

getBrookCoreyBubblingPressure() → float

setBrookCoreyBubblingPressure(value: float) → None

getGardnerA() → float

setGardnerA(value: float) → None

getGardnerN() → float

setGardnerN(value: float) → None

getEstimatedSoilType() → HydraulicSimpleSoilType

setEstimatedSoilType(value: HydraulicSimpleSoilType) → None

getWcSat() → float

Saturated water content (volumetric), when applicable.

setWcSat(value: float) → None

getWcRes() → float

Residual water content (volumetric), when applicable.

setWcRes(value: float) → None

getMv() → float

setMv(value: float) → None

getUseMv() → bool

setUseMv(value: bool) → None

getSpatiallyVariableHydraulic() → bool

setSpatiallyVariableHydraulic(value: bool) → None

getCorrelationLengthX() → float

setCorrelationLengthX(value: float) → None

getCorrelationLengthY() → float

setCorrelationLengthY(value: float) → None

getMeshSize() → float

setMeshSize(value: float) → None