rs3.properties.material.constitutiveModel.JointedGeneralizedHoekBrown module#

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

Bases: _ProxyObject, IPropertyGroupAccessors

getIntactUCS() → float#
setIntactUCS(value: float)#
getMbParameter() → float#
setMbParameter(value: float)#
getSParameter() → float#
setSParameter(value: float)#
getAParameter() → float#
setAParameter(value: float)#
getResidualMbParameter() → float#
setResidualMbParameter(value: float)#
getResidualSParameter() → float#
setResidualSParameter(value: float)#
getResidualAParameter() → float#
setResidualAParameter(value: float)#
getDilationParameter() → float#
setDilationParameter(value: float)#
getTensileCutoff() → float#
setTensileCutoff(value: float)#
getApplySSRShearStrengthReduction() → bool#
setApplySSRShearStrengthReduction(value: bool)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(IntactUCS: float = None, MbParameter: float = None, SParameter: float = None, AParameter: float = None, ResidualMbParameter: float = None, ResidualSParameter: float = None, ResidualAParameter: float = None, DilationParameter: float = None, TensileCutoff: float = None, ApplySSRShearStrengthReduction: bool = None)#

Set properties using keyword arguments.

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

Bases: IStageFactorBase

getAParameterFactor() → float#
getResidualAParameterFactor() → float#
getDilationParameterFactor() → float#
getUCSOfIntactRockFactor() → float#
getMbParameterFactor() → float#
getResidualMbParameterFactor() → float#
getSParameterFactor() → float#
getResidualSParameterFactor() → float#
class rs3.properties.material.constitutiveModel.JointedGeneralizedHoekBrown.JointedGeneralizedHoekBrownDefinedStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: JointedGeneralizedHoekBrownStageFactorBase

setAParameterFactor(value: float)#
setResidualAParameterFactor(value: float)#
setDilationParameterFactor(value: float)#
setUCSOfIntactRockFactor(value: float)#
setMbParameterFactor(value: float)#
setResidualMbParameterFactor(value: float)#
setSParameterFactor(value: float)#
setResidualSParameterFactor(value: float)#
class rs3.properties.material.constitutiveModel.JointedGeneralizedHoekBrown.JointedGeneralizedHoekBrownStageFactor(id: str, stageFactorId: str, client: Client)#

Bases: JointedGeneralizedHoekBrownStageFactorBase

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

Bases: JointedGeneralizedHoekBrownDefinedStageFactorBase

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

Bases: JointedGeneralizedHoekBrownBase

getElasticType() → MaterialElasticityTypes#
setElasticType(StiffnessType: MaterialElasticityTypes)#
getMaterialType() → MaterialType#
setMaterialType(materialType: MaterialType)#
getTensileCutoffType() → TensileCutoffOptions#
setTensileCutoffType(tensionCutoffOption: TensileCutoffOptions)#
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)