rs3.projectSettings.Groundwater module#
- class rs3.projectSettings.Groundwater.GroundwaterBase(client: Client, id: str)#
Bases:
_ProxyObject,IPropertyGroupAccessors- getPoreFluidUnitWeight() float#
- setPoreFluidUnitWeight(value: float)#
- getIsNegativePorePressureCutoff() bool#
- setIsNegativePorePressureCutoff(value: bool)#
- getNegativePorePressureCutoff() float#
- setNegativePorePressureCutoff(value: float)#
- getPWPMethodByStage() bool#
- setPWPMethodByStage(value: bool)#
- getMaxNumIterations() int#
- setMaxNumIterations(value: int)#
- getTolerance() float#
- setTolerance(value: float)#
- getLoadSteps() int#
- setLoadSteps(value: int)#
- getTimeSteps() int#
- setTimeSteps(value: int)#
- getIsScaleTolerance() bool#
- setIsScaleTolerance(value: bool)#
- getIsAddFluidBodyForce() bool#
- setIsAddFluidBodyForce(value: bool)#
- getFluidBulkModulus() float#
- setFluidBulkModulus(value: float)#
- getProperties()#
Retrieve properties as a dictionary.
- setProperties(PoreFluidUnitWeight: float = None, IsNegativePorePressureCutoff: bool = None, NegativePorePressureCutoff: float = None, PWPMethodByStage: bool = None, MaxNumIterations: int = None, Tolerance: float = None, LoadSteps: int = None, TimeSteps: int = None, IsScaleTolerance: bool = None, IsAddFluidBodyForce: bool = None, FluidBulkModulus: float = None)#
Set properties using keyword arguments.
- class rs3.projectSettings.Groundwater.Groundwater(client: Client, id: str)#
Bases:
GroundwaterBaseDefine the method to establish groundwater pore pressure conditions in the model.
Examples
See Project Settings Script Examples.
- getGroundwaterMethod() GroundwaterMethodType#
- setGroundwaterMethod(value: GroundwaterMethodType)#
- setLoadStepType(value: GWLoadStepType)#
- getLoadStepType() GWLoadStepType#
- setTimeStepType(value: TimeStepType)#
- getTimeStepType() TimeStepType#