rs3.properties.material.hydraulic.Hydraulic module

class rs3.properties.material.hydraulic.Hydraulic.HydraulicBase(client: Client, id: str)

Bases: _ProxyObject, IPropertyGroupAccessors

getPorosityValue() → float

setPorosityValue(value: float)

getVoidRatio() → float

setVoidRatio(value: float)

getDefineMaximumNegativePoreWaterPressure() → bool

setDefineMaximumNegativePoreWaterPressure(value: bool)

getMaximumNegativePoreWaterPressure() → float

setMaximumNegativePoreWaterPressure(value: float)

getUseBiotsCoefficientForCalculatingEffectiveStress() → bool

setUseBiotsCoefficientForCalculatingEffectiveStress(value: bool)

getUseCustomBiotsCoefficient() → bool

setUseCustomBiotsCoefficient(value: bool)

getBiotsCoefficient() → float

setBiotsCoefficient(value: float)

getProperties()

Retrieve properties as a dictionary.

setProperties(PorosityValue: float = None, VoidRatio: float = None, DefineMaximumNegativePoreWaterPressure: bool = None, MaximumNegativePoreWaterPressure: float = None, UseBiotsCoefficientForCalculatingEffectiveStress: bool = None, UseCustomBiotsCoefficient: bool = None, BiotsCoefficient: float = None)

Set properties using keyword arguments.

class rs3.properties.material.hydraulic.Hydraulic.HydraulicStageFactor(id: str, stageFactorID: str, client: Client)

Bases: IStageFactorBase

Examples

See Material Stage Factors Script Examples.

getMaterialBehaviorType() → MaterialBehaviours

class rs3.properties.material.hydraulic.Hydraulic.HydraulicDefinedStageFactor(id: str, stageFactorID: str, client: Client)

Bases: HydraulicStageFactor

Examples

See Material Stage Factors Script Examples.

setMaterialBehaviorType(materialBehaviorType: MaterialBehaviours)

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

Bases: HydraulicBase

Examples

See Material Hydraulic Script Examples.

setMaterialBehavior(materialBehaviorType: MaterialBehaviours)

getMaterialBehavior() → MaterialBehaviours

setPorosityType(porosityType: PorosityType)

getPorosityType() → PorosityType