rs2.modeler.properties.joint package

rs2.modeler.properties.joint.BartonBandis module

class rs2.modeler.properties.joint.BartonBandis.BartonBandisStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getNormalStiffnessFactor() → float

getShearStiffnessFactor() → float

getJCSFactor() → float

getJRCFactor() → float

getResidualFrictionAngleFactor() → float

getAdditionalPressureInsideJointFactor() → float

getGroundwaterPressureFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.BartonBandis.BartonBandisDefinedStageFactor(client: Client, ID, propertyID)

Bases: BartonBandisStageFactor

setNormalStiffnessFactor(value: float)

setShearStiffnessFactor(value: float)

setJCSFactor(value: float)

setJRCFactor(value: float)

setResidualFrictionAngleFactor(value: float)

setAdditionalPressureInsideJointFactor(value: float)

setGroundwaterPressureFactor(GroundWaterPressure: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[BartonBandisDefinedStageFactor, BartonBandisStageFactor]

getJCS() → float

setJCS(value: float)

getJRC() → float

setJRC(value: float)

getResidualFrictionAngle() → float

setResidualFrictionAngle(value: float)

getResidualStrength() → bool

setResidualStrength(value: bool)

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)

setPiezoID(piezoName: str)

getPiezoID()

setProperties(JCS: float = None, JRC: float = None, ResidualFrictionAngle: float = None, ResidualStrength: bool = None, 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()

rs2.modeler.properties.joint.BartonBandisMaterial module

class rs2.modeler.properties.joint.BartonBandisMaterial.BartonBandisMaterialStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getJCSFactor() → float

getJRCFactor() → float

getResidualFrictionAngleFactor() → float

getDilationAngleFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.BartonBandisMaterial.BartonBandisMaterialDefinedStageFactor(client: Client, ID, propertyID)

Bases: BartonBandisMaterialStageFactor

setJCSFactor(value: float)

setJRCFactor(value: float)

setResidualFrictionAngleFactor(value: float)

setDilationAngleFactor(dilationAngleFactor: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Material Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[BartonBandisMaterialDefinedStageFactor, BartonBandisMaterialStageFactor]

getJCS() → float

setJCS(value: float)

getJRC() → float

setJRC(value: float)

getResidualFrictionAngle() → float

setResidualFrictionAngle(value: float)

getResidualStrength() → bool

setResidualStrength(value: bool)

getApplyStageFactors() → bool

setApplyStageFactors(value: bool)

setDilationAngle(dilationAngle: float)

getDilationAngle() → float

setProperties(JCS: float = None, JRC: float = None, ResidualFrictionAngle: float = None, ResidualStrength: bool = None, ApplyStageFactors: bool = None)

getProperties()

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

Examples

Code Snippet: Manipulation of Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[DisplacementDependentDefinedStageFactor, DisplacementDependentStageFactor]

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()

rs2.modeler.properties.joint.GeosyntheticHyperbolic module

class rs2.modeler.properties.joint.GeosyntheticHyperbolic.GeosyntheticHyperbolicStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getNormalStiffnessFactor() → float

getShearStiffnessFactor() → float

getPeakAdhesionAtSigninfFactor() → float

getPeakFrictionAngleAtSign0Factor() → float

getResAdhesionAtSigninfFactor() → float

getResFrictionAngleAtSign0Factor() → float

getAdditionalPressureInsideJointFactor() → float

getGroundwaterPressureFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.GeosyntheticHyperbolic.GeosyntheticHyperbolicDefinedStageFactor(client: Client, ID, propertyID)

Bases: GeosyntheticHyperbolicStageFactor

setNormalStiffnessFactor(value: float)

setShearStiffnessFactor(value: float)

setPeakAdhesionAtSigninfFactor(value: float)

setPeakFrictionAngleAtSign0Factor(value: float)

setResAdhesionAtSigninfFactor(value: float)

setResFrictionAngleAtSign0Factor(value: float)

setAdditionalPressureInsideJointFactor(value: float)

setGroundwaterPressureFactor(GroundWaterPressure: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[GeosyntheticHyperbolicDefinedStageFactor, GeosyntheticHyperbolicStageFactor]

getPeakAdhesionAtSigninf() → float

setPeakAdhesionAtSigninf(value: float)

getPeakFrictionAngleAtSign0() → float

setPeakFrictionAngleAtSign0(value: float)

getResAdhesionAtSigninf() → float

setResAdhesionAtSigninf(value: float)

getResFrictionAngleAtSign0() → float

setResFrictionAngleAtSign0(value: float)

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)

setPiezoID(piezoName: str)

getPiezoID()

setProperties(PeakAdhesionAtSigninf: float = None, PeakFrictionAngleAtSign0: float = None, ResAdhesionAtSigninf: float = None, ResFrictionAngleAtSign0: float = None, 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()

rs2.modeler.properties.joint.GeosyntheticHyperbolicMaterial module

class rs2.modeler.properties.joint.GeosyntheticHyperbolicMaterial.GeosyntheticHyperbolicMaterialStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getPeakAdhesionAtSigninfFactor() → float

getPeakFrictionAngleAtSign0Factor() → float

getResAdhesionAtSigninfFactor() → float

getResFrictionAngleAtSign0Factor() → float

getDilationRatioFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.GeosyntheticHyperbolicMaterial.GeosyntheticHyperbolicMaterialDefinedStageFactor(client: Client, ID, propertyID)

Bases: GeosyntheticHyperbolicMaterialStageFactor

setPeakAdhesionAtSigninfFactor(value: float)

setPeakFrictionAngleAtSign0Factor(value: float)

setResAdhesionAtSigninfFactor(value: float)

setResFrictionAngleAtSign0Factor(value: float)

setDilationRatioFactor(dilationRatioFactor: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Material Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[GeosyntheticHyperbolicMaterialDefinedStageFactor, GeosyntheticHyperbolicMaterialStageFactor]

getPeakAdhesionAtSigninf() → float

setPeakAdhesionAtSigninf(value: float)

getPeakFrictionAngleAtSign0() → float

setPeakFrictionAngleAtSign0(value: float)

getResAdhesionAtSigninf() → float

setResAdhesionAtSigninf(value: float)

getResFrictionAngleAtSign0() → float

setResFrictionAngleAtSign0(value: float)

getApplyStageFactors() → bool

setApplyStageFactors(value: bool)

getTensileStrength() → float

setTensileStrength(value: float)

setDilationRatio(dilationRatio: float)

getDilationRatio() → float

setProperties(PeakAdhesionAtSigninf: float = None, PeakFrictionAngleAtSign0: float = None, ResAdhesionAtSigninf: float = None, ResFrictionAngleAtSign0: float = None, ApplyStageFactors: bool = None, TensileStrength: float = None)

getProperties()

rs2.modeler.properties.joint.HyperbolicSoftening module

class rs2.modeler.properties.joint.HyperbolicSoftening.HyperbolicSofteningStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getNormalStiffnessFactor() → float

getShearStiffnessFactor() → float

getPeakCohesionFactor() → float

getPeakFrictionFactor() → float

getResCohesionFactor() → float

getResFrictionFactor() → float

getTensileStrengthFactor() → float

getResTensileStrengthFactor() → float

getDeltaRFactor() → float

getInitialSlopeFactor() → float

getWorkSofteningFactor() → bool

getAdditionalPressureInsideJointFactor() → float

getGroundwaterPressureFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.HyperbolicSoftening.HyperbolicSofteningDefinedStageFactor(client: Client, ID, propertyID)

Bases: HyperbolicSofteningStageFactor

setNormalStiffnessFactor(value: float)

setShearStiffnessFactor(value: float)

setPeakCohesionFactor(value: float)

setPeakFrictionFactor(value: float)

setResCohesionFactor(value: float)

setResFrictionFactor(value: float)

setTensileStrengthFactor(value: float)

setResTensileStrengthFactor(value: float)

setDeltaRFactor(value: float)

setInitialSlopeFactor(value: float)

setWorkSofteningFactor(value: bool)

setAdditionalPressureInsideJointFactor(value: float)

setGroundwaterPressureFactor(GroundWaterPressure: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[HyperbolicSofteningDefinedStageFactor, HyperbolicSofteningStageFactor]

getPeakCohesion() → float

setPeakCohesion(value: float)

getPeakFriction() → float

setPeakFriction(value: float)

getResCohesion() → float

setResCohesion(value: float)

getResFriction() → float

setResFriction(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getResTensileStrength() → float

setResTensileStrength(value: float)

getDeltaR() → float

setDeltaR(value: float)

getInitialSlope() → float

setInitialSlope(value: float)

getWorkSoftening() → bool

setWorkSoftening(value: bool)

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)

setPiezoID(piezoName: str)

getPiezoID()

setProperties(PeakCohesion: float = None, PeakFriction: float = None, ResCohesion: float = None, ResFriction: float = None, TensileStrength: float = None, ResTensileStrength: float = None, DeltaR: float = None, InitialSlope: float = None, WorkSoftening: bool = None, 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()

rs2.modeler.properties.joint.Joint module

class rs2.modeler.properties.joint.Joint.JointProperty(client: Client, ID, documentProxyID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Joint Properties

NoneSlip

Reference object for modifying property.

Type:

NoneSlip

MohrCoulomb

Reference object for modifying property.

Type:

MohrCoulomb

BartonBandis

Reference object for modifying property.

Type:

BartonBandis

GeosyntheticHyperbolic

Reference object for modifying property.

Type:

GeosyntheticHyperbolic

HyperbolicSoftening

Reference object for modifying property.

Type:

HyperbolicSoftening

MaterialDependent

Reference object for modifying property.

Type:

MaterialDependent

DisplacementDependent

Reference object for modifying property.

Type:

DisplacementDependent

getJointName() → str

setJointName(value: str)

getJointColor() → int

setJointColor(value: int)

getSlipCriterion() → JointTypes

setSlipCriterion(value: JointTypes)

getInitialDeformation() → bool

setInitialDeformation(value: bool)

SetApplySSR(applySSR: bool)

GetApplySSR() → bool

SetPermeable(permeable: bool)

GetPermeable() → bool

SetMeshConforming(meshConforming: bool)

GetMeshConforming() → bool

SetAllowSlipStartFromStage(stage: int)

GetAllowSlipStartFromStage() → int

rs2.modeler.properties.joint.MaterialDependent module

class rs2.modeler.properties.joint.MaterialDependent.MaterialDependentStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getNormalStiffnessFactor() → float

getShearStiffnessFactor() → float

getInterfaceCoefficientFactor() → float

getAdditionalPressureInsideJointFactor() → float

getGroundwaterPressureFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.MaterialDependent.MaterialDependentDefinedStageFactor(client: Client, ID, propertyID)

Bases: MaterialDependentStageFactor

setNormalStiffnessFactor(value: float)

setShearStiffnessFactor(value: float)

setInterfaceCoefficientFactor(value: float)

setAdditionalPressureInsideJointFactor(value: float)

setGroundwaterPressureFactor(GroundWaterPressure: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[MaterialDependentDefinedStageFactor, MaterialDependentStageFactor]

getInterfaceCoefficient() → float

setInterfaceCoefficient(value: float)

getDefineStiffness() → DefineStiffness

setDefineStiffness(value: DefineStiffness)

getNormalStiffness() → float

setNormalStiffness(value: float)

getShearStiffness() → float

setShearStiffness(value: float)

getStiffnessCoefficient() → float

setStiffnessCoefficient(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)

setPiezoID(piezoName: str)

getPiezoID()

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

getProperties()

rs2.modeler.properties.joint.MohrCoulomb module

class rs2.modeler.properties.joint.MohrCoulomb.MohrCoulombStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getNormalStiffnessFactor() → float

getShearStiffnessFactor() → float

getTensileStrengthFactor() → float

getPeakCohesionFactor() → float

getPeakFrictionAngleFactor() → float

getResCohesionFactor() → float

getResFrictionAngleFactor() → float

getResTensileStrengthFactor() → float

getAdditionalPressureInsideJointFactor() → float

getGroundwaterPressureFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.MohrCoulomb.MohrCoulombDefinedStageFactor(client: Client, ID, propertyID)

Bases: MohrCoulombStageFactor

setNormalStiffnessFactor(value: float)

setShearStiffnessFactor(value: float)

setTensileStrengthFactor(value: float)

setPeakCohesionFactor(value: float)

setPeakFrictionAngleFactor(value: float)

setResCohesionFactor(value: float)

setResFrictionAngleFactor(value: float)

setResTensileStrengthFactor(value: float)

setAdditionalPressureInsideJointFactor(value: float)

setGroundwaterPressureFactor(GroundWaterPressure: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[MohrCoulombDefinedStageFactor, MohrCoulombStageFactor]

getTensileStrength() → float

setTensileStrength(value: float)

getPeakCohesion() → float

setPeakCohesion(value: float)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getIncludeDilation() → bool

setIncludeDilation(value: bool)

getDilationAngle() → float

setDilationAngle(value: float)

getDMin() → float

setDMin(value: float)

getDMax() → float

setDMax(value: float)

getDirectional() → bool

setDirectional(value: bool)

getResidualStrength() → bool

setResidualStrength(value: bool)

getResTensileStrength() → float

setResTensileStrength(value: float)

getResCohesion() → float

setResCohesion(value: float)

getResFrictionAngle() → float

setResFrictionAngle(value: float)

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)

setPiezoID(piezoName: str)

getPiezoID()

setProperties(TensileStrength: float = None, PeakCohesion: float = None, PeakFrictionAngle: float = None, IncludeDilation: bool = None, DilationAngle: float = None, DMin: float = None, DMax: float = None, Directional: bool = None, ResidualStrength: bool = None, ResTensileStrength: float = None, ResCohesion: float = None, ResFrictionAngle: float = None, 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()

rs2.modeler.properties.joint.MohrCoulombMaterial module

class rs2.modeler.properties.joint.MohrCoulombMaterial.MohrCoulombMaterialStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getTensileStrengthFactor() → float

getPeakFrictionAngleFactor() → float

getPeakCohesionFactor() → float

getResTensileStrengthFactor() → float

getResCohesionFactor() → float

getResFrictionAngleFactor() → float

getDilationAngleFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.MohrCoulombMaterial.MohrCoulombMaterialDefinedStageFactor(client: Client, ID, propertyID)

Bases: MohrCoulombMaterialStageFactor

setTensileStrengthFactor(value: float)

setPeakFrictionAngleFactor(value: float)

setPeakCohesionFactor(value: float)

setResTensileStrengthFactor(value: float)

setResCohesionFactor(value: float)

setResFrictionAngleFactor(value: float)

setDilationAngleFactor(dilationAngleFactor: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Material Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[MohrCoulombMaterialDefinedStageFactor, MohrCoulombMaterialStageFactor]

getTensileStrength() → float

setTensileStrength(value: float)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getPeakCohesion() → float

setPeakCohesion(value: float)

getResidualStrength() → bool

setResidualStrength(value: bool)

getResTensileStrength() → float

setResTensileStrength(value: float)

getResCohesion() → float

setResCohesion(value: float)

getResFrictionAngle() → float

setResFrictionAngle(value: float)

getApplyStageFactors() → bool

setApplyStageFactors(value: bool)

setDilationAngle(dilationAngle: float)

getDilationAngle() → float

setProperties(TensileStrength: float = None, PeakFrictionAngle: float = None, PeakCohesion: float = None, ResidualStrength: bool = None, ResTensileStrength: float = None, ResCohesion: float = None, ResFrictionAngle: float = None, ApplyStageFactors: bool = None)

getProperties()

rs2.modeler.properties.joint.NoneSlip module

class rs2.modeler.properties.joint.NoneSlip.NoneSlipStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getNormalStiffnessFactor() → float

getShearStiffnessFactor() → float

getAdditionalPressureInsideJointFactor() → float

getGroundwaterPressureFactor() → float

getJointPermeableFactor() → bool

class rs2.modeler.properties.joint.NoneSlip.NoneSlipDefinedStageFactor(client: Client, ID, propertyID)

Bases: NoneSlipStageFactor

setNormalStiffnessFactor(value: float)

setShearStiffnessFactor(value: float)

setAdditionalPressureInsideJointFactor(value: float)

setGroundwaterPressureFactor(GroundWaterPressure: float)

setJointPermeableFactor(Permeable: bool)

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

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Joint Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[NoneSlipDefinedStageFactor, NoneSlipStageFactor]

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)

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()