rs3.properties.material.constitutiveModel.GeneralizedHoekBrown module#

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

Bases: _ProxyObject, IPropertyGroupAccessors

getUCSOfIntactRock() → float#
setUCSOfIntactRock(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)#
getGSI() → float#
setGSI(value: float)#
getMi() → float#
setMi(value: float)#
getD() → float#
setD(value: float)#
getResidualToPeak() → bool#
setResidualToPeak(value: bool)#
getResidualGSI() → float#
setResidualGSI(value: float)#
getResidualMi() → float#
setResidualMi(value: float)#
getResidualD() → float#
setResidualD(value: float)#
getDilationParameter() → float#
setDilationParameter(value: float)#
getTensileCutoff() → float#
setTensileCutoff(value: float)#
getApplySSRShearStrengthReduction() → bool#
setApplySSRShearStrengthReduction(value: bool)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(UCSOfIntactRock: float = None, MbParameter: float = None, SParameter: float = None, AParameter: float = None, ResidualMbParameter: float = None, ResidualSParameter: float = None, ResidualAParameter: float = None, GSI: float = None, Mi: float = None, D: float = None, ResidualToPeak: bool = None, ResidualGSI: float = None, ResidualMi: float = None, ResidualD: float = None, DilationParameter: float = None, TensileCutoff: float = None, ApplySSRShearStrengthReduction: bool = None)#

Set properties using keyword arguments.

class rs3.properties.material.constitutiveModel.GeneralizedHoekBrown.GeneralizedHoekBrownStageFactorBase(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.GeneralizedHoekBrown.GeneralizedHoekBrownDefinedStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: GeneralizedHoekBrownStageFactorBase

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.GeneralizedHoekBrown.GeneralizedHoekBrownStageFactor(id: str, stageFactorId: str, client: Client)#

Bases: GeneralizedHoekBrownStageFactorBase

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

Bases: GeneralizedHoekBrownDefinedStageFactorBase

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

Bases: GeneralizedHoekBrownBase, BaseConstitutiveModel

getUsingGSIMIDCalc() → bool#

Get generalized hoek brown model is defined by GSI, mi, d method or mb, s, a method.

UI Label:

Defined By

setUsingGSIMIDCalc(value: bool)#

Define generalized hoek brown model by GSI, mi, d method or mb, s, a method.

UI Label:

Defined By

getTensileCutoffType() → TensileCutoffOptions#
setTensileCutoffType(TensionCutOff: TensileCutoffOptions)#