rs3.properties.material.constitutiveModel.UnsaturatedZoneCalculations module#

class rs3.properties.material.constitutiveModel.UnsaturatedZoneCalculations.UnsaturatedZoneCalculationsBase(client: Client, id: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getUseCutoff() → bool#

setUseCutoff(value: bool)#

getCutoffValue() → float#

setCutoffValue(value: float)#

getAlpha() → float#

setAlpha(value: float)#

getAirEntrySuction() → float#

setAirEntrySuction(value: float)#

getCriticalSuction() → float#

setCriticalSuction(value: float)#

getMaterialParameter() → float#

setMaterialParameter(value: float)#

getProperties()#: Retrieve properties as a dictionary.

setProperties(UseCutoff: bool = None, CutoffValue: float = None, Alpha: float = None, AirEntrySuction: float = None, CriticalSuction: float = None, MaterialParameter: float = None)#: Set properties using keyword arguments.

class rs3.properties.material.constitutiveModel.UnsaturatedZoneCalculations.UnsaturatedZoneCalculations(client: Client, id: str)#

Bases: UnsaturatedZoneCalculationsBase

getUnsaturatedBehavior() → UnsaturatedParameterType#

setUnsaturatedBehavior(unsaturatedParameterType: UnsaturatedParameterType)#

getSingleEffectiveStressMethod() → UnsaturatedSingleEffectiveStressMethod#

setSingleEffectiveStressMethod(unsaturatedSingleEffectiveStressMethod: UnsaturatedSingleEffectiveStressMethod)#

getTabularValues() → UnsaturatedTabularValueMethod#

setTabularValues(unsaturatedTabularValueMethod: UnsaturatedTabularValueMethod)#

getUnsaturatedZoneTableWithRespectToSuction() → list[tuple[float, float]]#: Returns a list of tuples where the first element is coefficients and the second is values with respect to suction.

setUnsaturatedZoneTableWithRespectToSuction(values: list[tuple[float, float]])#: Specify the coefficient and values with respect to suction.

getUnsaturatedZoneTableWithRespectToDegreeOfSaturation() → list[tuple[float, float]]#: Returns a list of tuples where the first element is coefficients and the second is values with respect to degree of saturation.

setUnsaturatedZoneTableWithRespectToDegreeOfSaturation(values: list[tuple[float, float]])#: Specify the coefficient and values with respect to degree of saturation.

getUnsaturatedZoneTableWithRespectToEffectiveDegreeOfSaturation() → list[tuple[float, float]]#: Returns a list of tuples where the first element is coefficients and the second is values with respect to effective degree of saturation.

setUnsaturatedZoneTableWithRespectToEffectiveDegreeOfSaturation(values: list[tuple[float, float]])#: Specify the coefficient and values with respect to effective degree of saturation.