rs3.properties.material.constitutiveModel.JointedMohrCoulomb module#

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

Bases: _ProxyObject, IPropertyGroupAccessors

getTensileStrength() → float#
setTensileStrength(value: float)#
getFrictionAngle() → float#
setFrictionAngle(value: float)#
getCohesion() → float#
setCohesion(value: float)#
getResidualTensileStrength() → float#
setResidualTensileStrength(value: float)#
getResidualFrictionAngle() → float#
setResidualFrictionAngle(value: float)#
getResidualCohesion() → float#
setResidualCohesion(value: float)#
getDilationAngle() → float#
setDilationAngle(value: float)#
getApplySSRShearStrengthReduction() → bool#
setApplySSRShearStrengthReduction(value: bool)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(TensileStrength: float = None, FrictionAngle: float = None, Cohesion: float = None, ResidualTensileStrength: float = None, ResidualFrictionAngle: float = None, ResidualCohesion: float = None, DilationAngle: float = None, ApplySSRShearStrengthReduction: bool = None)#

Set properties using keyword arguments.

class rs3.properties.material.constitutiveModel.JointedMohrCoulomb.JointedMohrCoulombStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: IStageFactorBase

getCohesionFactor() → float#
getResidualCohesionFactor() → float#
getDilationAngleFactor() → float#
getFrictionAngleFactor() → float#
getResidualFrictionAngleFactor() → float#
getResetYieldFactor() → bool#
getTensileStrengthFactor() → float#
getResidualTensileStrengthFactor() → float#
getUnsaturatedAirEntryFactor() → float#
getUnsaturatedPhiBFactor() → float#
class rs3.properties.material.constitutiveModel.JointedMohrCoulomb.JointedMohrCoulombDefinedStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: JointedMohrCoulombStageFactorBase

setCohesionFactor(value: float)#
setResidualCohesionFactor(value: float)#
setDilationAngleFactor(value: float)#
setFrictionAngleFactor(value: float)#
setResidualFrictionAngleFactor(value: float)#
setResetYieldFactor(value: bool)#
setTensileStrengthFactor(value: float)#
setResidualTensileStrengthFactor(value: float)#
setUnsaturatedAirEntryFactor(value: float)#
setUnsaturatedPhiBFactor(value: float)#
class rs3.properties.material.constitutiveModel.JointedMohrCoulomb.JointedMohrCoulombStageFactor(id: str, stageFactorId: str, client: Client)#

Bases: JointedMohrCoulombStageFactorBase

class rs3.properties.material.constitutiveModel.JointedMohrCoulomb.JointedMohrCoulombDefinedStageFactor(id: str, stageFactorID: str, client: Client)#

Bases: JointedMohrCoulombDefinedStageFactorBase

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

Bases: JointedMohrCoulombBase

getElasticType() → MaterialElasticityTypes#
setElasticType(StiffnessType: MaterialElasticityTypes)#
getMaterialType() → MaterialType#
setMaterialType(materialType: MaterialType)#
getJointOptions() → MaterialJointOptions#

Get all joint option controls.

Example

See 2.4 Jointed Mohr Coulomb.

>>> material = model.getAllMaterialProperties()[0]
>>> jointOptions = material.ConstitutiveModel.JointedGeneralizedHoekBrown.getJointOptions()
>>> jointOptions.setNumberOfJoint(3)
>>> firstJoint = jointOptions.getJoint(1)