rs2.modeler.properties.joint.DisplacementDependent module#

class rs2.modeler.properties.joint.DisplacementDependent.DisplacementDependentStageFactor(client: Client, ID, propertyID)#

Bases: ProxyObject

getNormalStiffnessFactor() → float#

getShearStiffnessFactor() → float#

getShearDisplacementFactor() → float#

getCohesionFactor() → float#

getFrictionAngleFactor() → float#

getTensileStrengthFactor() → float#

getAdditionalPressureInsideJointFactor() → float#

getGroundwaterPressureFactor() → float#

getJointPermeableFactor() → bool#

class rs2.modeler.properties.joint.DisplacementDependent.DisplacementDependentDefinedStageFactor(client: Client, ID, propertyID)#

Bases: DisplacementDependentStageFactor

setNormalStiffnessFactor(value: float)#

setShearStiffnessFactor(value: float)#

setShearDisplacementFactor(value: float)#

setCohesionFactor(value: float)#

setFrictionAngleFactor(value: float)#

setTensileStrengthFactor(value: float)#

setAdditionalPressureInsideJointFactor(value: float)#

setGroundwaterPressureFactor(GroundWaterPressure: float)#

setJointPermeableFactor(Permeable: bool)#

class rs2.modeler.properties.joint.DisplacementDependent.DisplacementDependent(client: Client, ID, documentProxyID)#

Bases: PropertyProxy

Variables:: stageFactorInterface (AbsoluteStageFactorInterface[DisplacementDependentDefinedStageFactor, DisplacementDependentStageFactor]) – Reference object for modifying stage factor property.

Examples

Code Snippet: Manipulation of Joint Stage Factor Properties

getNormalStiffness() → float#

setNormalStiffness(value: float)#

getShearStiffness() → float#

setShearStiffness(value: float)#

getApplyPorePressure() → bool#

setApplyPorePressure(value: bool)#

getApplyAdditionalPressureInsideJoint() → bool#

setApplyAdditionalPressureInsideJoint(value: bool)#

getAdditionalPressureType() → AdditionalPressureType#

setAdditionalPressureType(value: AdditionalPressureType)#

getAdditionalPressureInsideJoint() → float#

setAdditionalPressureInsideJoint(value: float)#

getApplyPressureToLinerSideOnly() → bool#

setApplyPressureToLinerSideOnly(value: bool)#

getApplyStageFactors() → bool#

setApplyStageFactors(value: bool)#

getDisplacementDependentTable() → List[List[float]]#: displacementGrid is a 2D Array representing a Displacement Dependent Grid. The first column represents Shear Displacement, the second column represents Cohesion, the third column represents Friction Angle, and the fourth column represents Tensile Strength.

setDisplacementDependentTable(displacementGrid: List[List[float]])#: displacementGrid is a 2D Array representing a Displacement Dependent Grid. Rows of the 2D Array must be of length 4. A minimum of two rows is required. The first column represents Shear Displacement, the second column represents Cohesion, the third column represents Friction Angle, and the fourth column represents Tensile Strength.

setPiezoID(piezoName: str)#

getPiezoID()#

setProperties(NormalStiffness: float = None, ShearStiffness: float = None, ApplyPorePressure: bool = None, ApplyAdditionalPressureInsideJoint: bool = None, AdditionalPressureType: AdditionalPressureType = None, AdditionalPressureInsideJoint: float = None, ApplyPressureToLinerSideOnly: bool = None, ApplyStageFactors: bool = None)#

getProperties()#