rs2.modeler.properties.material.strength package

rs2.modeler.properties.material.strength.AnisotropicLinear module

class rs2.modeler.properties.material.strength.AnisotropicLinear.AnisotropicLinear(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getA1Parameter() → float

setA1Parameter(value: float)

getB1Parameter() → float

setB1Parameter(value: float)

getUseTensileStrength() → bool

setUseTensileStrength(value: bool)

getCohesion1() → float

setCohesion1(value: float)

getCohesion2() → float

setCohesion2(value: float)

getFrictionAngle1() → float

setFrictionAngle1(value: float)

getFrictionAngle2() → float

setFrictionAngle2(value: float)

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getResidualCohesion1() → float

setResidualCohesion1(value: float)

getResidualCohesion2() → float

setResidualCohesion2(value: float)

getResidualFrictionAngle1() → float

setResidualFrictionAngle1(value: float)

getResidualFrictionAngle2() → float

setResidualFrictionAngle2(value: float)

getDilationAngle1() → float

setDilationAngle1(value: float)

getDilationAngle2() → float

setDilationAngle2(value: float)

getResidualTensileStrength() → float

setResidualTensileStrength(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

getAnisotropyDefinition() → AnisotropyDefinitions

setAnisotropyDefinition(value: AnisotropyDefinitions)

getAngleCcwTo1() → float

setAngleCcwTo1(value: float)

setAnisotropicSurfaceByName(surfaceName: str)

Sets the anisotropic surface by name. The surface must be defined in the model.

getAnisotropicSurfaceName() → str

setProperties(MaterialType: MaterialType = None, A1Parameter: float = None, B1Parameter: float = None, UseTensileStrength: bool = None, Cohesion1: float = None, Cohesion2: float = None, FrictionAngle1: float = None, FrictionAngle2: float = None, PeakTensileStrength: float = None, ResidualCohesion1: float = None, ResidualCohesion2: float = None, ResidualFrictionAngle1: float = None, ResidualFrictionAngle2: float = None, DilationAngle1: float = None, DilationAngle2: float = None, ResidualTensileStrength: float = None, ApplySSRShearStrengthReduction: bool = None, AnisotropyDefinition: AnisotropyDefinitions = None, AngleCcwTo1: float = None)

getProperties()

rs2.modeler.properties.material.strength.BarcelonaBasic module

class rs2.modeler.properties.material.strength.BarcelonaBasic.BarcelonaBasicStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getCriticalStateSlopeFactor() → float

getGammaFactor() → float

getKappaFactor() → float

getLambdaFactor() → float

getNParameterFactor() → float

getOverconsolidationRatioFactor() → float

getPreconsolidationStressFactor() → float

class rs2.modeler.properties.material.strength.BarcelonaBasic.BarcelonaBasicDefinedStageFactor(client: Client, ID, propertyID)

Bases: BarcelonaBasicStageFactor

setCriticalStateSlopeFactor(value: float)

setGammaFactor(value: float)

setKappaFactor(value: float)

setLambdaFactor(value: float)

setNParameterFactor(value: float)

setOverconsolidationRatioFactor(value: float)

setPreconsolidationStressFactor(value: float)

class rs2.modeler.properties.material.strength.BarcelonaBasic.BarcelonaBasic(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[BarcelonaBasicDefinedStageFactor, BarcelonaBasicStageFactor]

getSlopeOfCriticalStateLines() → float

setSlopeOfCriticalStateLines(value: float)

getIncludeTheEffectOfLodesAngle() → bool

setIncludeTheEffectOfLodesAngle(value: bool)

getLambda() → float

setLambda(value: float)

getKappa() → float

setKappa(value: float)

getSpecificVolumeAtUnitPressure() → float

setSpecificVolumeAtUnitPressure(value: float)

getInitialStateOfConsolidation() → InitialStateOfConsolidation

setInitialStateOfConsolidation(value: InitialStateOfConsolidation)

getOverConsolidationRatio() → float

setOverConsolidationRatio(value: float)

getPreconsolidationPressure() → float

setPreconsolidationPressure(value: float)

getElasticParameters() → ElasticParameters

setElasticParameters(value: ElasticParameters)

getAutoCalculateAlfaFactor() → bool

setAutoCalculateAlfaFactor(value: bool)

getAlfaFactor() → float

setAlfaFactor(value: float)

getMinimumBulkModulus() → float

setMinimumBulkModulus(value: float)

getKTensionSuction() → float

setKTensionSuction(value: float)

getKapaSuction() → float

setKapaSuction(value: float)

getRParameter() → float

setRParameter(value: float)

getBetaParameter() → float

setBetaParameter(value: float)

getReferenceMeanStress() → float

setReferenceMeanStress(value: float)

getAtmosphericPressure() → float

setAtmosphericPressure(value: float)

setProperties(SlopeOfCriticalStateLines: float = None, IncludeTheEffectOfLodesAngle: bool = None, Lambda: float = None, Kappa: float = None, SpecificVolumeAtUnitPressure: float = None, InitialStateOfConsolidation: InitialStateOfConsolidation = None, OverConsolidationRatio: float = None, PreconsolidationPressure: float = None, ElasticParameters: ElasticParameters = None, AutoCalculateAlfaFactor: bool = None, AlfaFactor: float = None, MinimumBulkModulus: float = None, KTensionSuction: float = None, KapaSuction: float = None, RParameter: float = None, BetaParameter: float = None, ReferenceMeanStress: float = None, AtmosphericPressure: float = None)

getProperties()

rs2.modeler.properties.material.strength.BartonBandisStrength module

class rs2.modeler.properties.material.strength.BartonBandisStrength.BartonBandisStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getPhiR() → float

setPhiR(value: float)

getJRC() → float

setJRC(value: float)

getJCS() → float

setJCS(value: float)

getDilationRatio() → float

setDilationRatio(value: float)

getResidualStrength() → bool

setResidualStrength(value: bool)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setProperties(MaterialType: MaterialType = None, PhiR: float = None, JRC: float = None, JCS: float = None, DilationRatio: float = None, ResidualStrength: bool = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.BoundingSurfacePlasticity module

class rs2.modeler.properties.material.strength.BoundingSurfacePlasticity.BoundingSurfacePlasticity(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getPeakCohesion() → float

setPeakCohesion(value: float)

getCriticalFrictionAngleZeroDilation() → float

setCriticalFrictionAngleZeroDilation(value: float)

getHardeningProperty() → float

setHardeningProperty(value: float)

getUnloadingToLoadingPlasticModulusRatio() → float

setUnloadingToLoadingPlasticModulusRatio(value: float)

getPowerTerm() → float

setPowerTerm(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setProperties(PeakTensileStrength: float = None, PeakFrictionAngle: float = None, PeakCohesion: float = None, CriticalFrictionAngleZeroDilation: float = None, HardeningProperty: float = None, UnloadingToLoadingPlasticModulusRatio: float = None, PowerTerm: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.CamClay module

class rs2.modeler.properties.material.strength.CamClay.CamClayStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getCriticalStateSlopeFactor() → float

getGammaFactor() → float

getKappaFactor() → float

getLambdaFactor() → float

getNParameterFactor() → float

getOverconsolidationRatioFactor() → float

getPreconsolidationStressFactor() → float

class rs2.modeler.properties.material.strength.CamClay.CamClayDefinedStageFactor(client: Client, ID, propertyID)

Bases: CamClayStageFactor

setCriticalStateSlopeFactor(value: float)

setGammaFactor(value: float)

setKappaFactor(value: float)

setLambdaFactor(value: float)

setNParameterFactor(value: float)

setOverconsolidationRatioFactor(value: float)

setPreconsolidationStressFactor(value: float)

class rs2.modeler.properties.material.strength.CamClay.CamClay(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[CamClayDefinedStageFactor, CamClayStageFactor]

getCriticalStateSlope() → float

setCriticalStateSlope(value: float)

getSpecificVolumeAtUnitPressure() → SpecificVolumeAtUnitPressure

setSpecificVolumeAtUnitPressure(value: SpecificVolumeAtUnitPressure)

getNParameter() → float

setNParameter(value: float)

getGamma() → float

setGamma(value: float)

getKappa() → float

setKappa(value: float)

getInitialStateOfConsolidation() → InitialStateOfConsolidation

setInitialStateOfConsolidation(value: InitialStateOfConsolidation)

getOverconsolidationRatio() → float

setOverconsolidationRatio(value: float)

getPreconsolidationStress() → float

setPreconsolidationStress(value: float)

getLambda() → float

setLambda(value: float)

setProperties(CriticalStateSlope: float = None, SpecificVolumeAtUnitPressure: SpecificVolumeAtUnitPressure = None, NParameter: float = None, Gamma: float = None, Kappa: float = None, InitialStateOfConsolidation: InitialStateOfConsolidation = None, OverconsolidationRatio: float = None, PreconsolidationStress: float = None, Lambda: float = None)

getProperties()

rs2.modeler.properties.material.strength.ChSoilStrength module

class rs2.modeler.properties.material.strength.ChSoilStrength.ChSoilStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getFrictionAngleFailure() → float

setFrictionAngleFailure(value: float)

getCohesion() → float

setCohesion(value: float)

getFailureRatio() → float

setFailureRatio(value: float)

getFrictionAngleNormallyConsolidated() → float

setFrictionAngleNormallyConsolidated(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getDilationOption() → DilationOption

setDilationOption(value: DilationOption)

getConstantVolumeFrictionAngle() → float

setConstantVolumeFrictionAngle(value: float)

setProperties(FrictionAngleFailure: float = None, Cohesion: float = None, FailureRatio: float = None, FrictionAngleNormallyConsolidated: float = None, TensileStrength: float = None, DilationAngle: float = None, DilationOption: DilationOption = None, ConstantVolumeFrictionAngle: float = None)

getProperties()

rs2.modeler.properties.material.strength.CySoilStrength module

class rs2.modeler.properties.material.strength.CySoilStrength.CySoilStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getCap() → CySoilCapOption

setCap(value: CySoilCapOption)

getAlfaCap() → float

setAlfaCap(value: float)

getNormallyConsolidatedCapPressure() → float

setNormallyConsolidatedCapPressure(value: float)

getFrictionAngleFailure() → float

setFrictionAngleFailure(value: float)

getCohesion() → float

setCohesion(value: float)

getFailureRatio() → float

setFailureRatio(value: float)

getFrictionAngleNormallyConsolidated() → float

setFrictionAngleNormallyConsolidated(value: float)

getBetaShearCalibrationFactor() → float

setBetaShearCalibrationFactor(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getDilationOption() → DilationOption

setDilationOption(value: DilationOption)

getConstantVolumeFrictionAngle() → float

setConstantVolumeFrictionAngle(value: float)

setProperties(Cap: CySoilCapOption = None, AlfaCap: float = None, NormallyConsolidatedCapPressure: float = None, FrictionAngleFailure: float = None, Cohesion: float = None, FailureRatio: float = None, FrictionAngleNormallyConsolidated: float = None, BetaShearCalibrationFactor: float = None, TensileStrength: float = None, DilationAngle: float = None, DilationOption: DilationOption = None, ConstantVolumeFrictionAngle: float = None)

getProperties()

rs2.modeler.properties.material.strength.DiscreteFunction module

class rs2.modeler.properties.material.strength.DiscreteFunction.DiscreteFunctionStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getPeakTensileStrengthFactor() → float

getResidualTensileStrengthFactor() → float

class rs2.modeler.properties.material.strength.DiscreteFunction.DiscreteFunctionDefinedStageFactor(client: Client, ID, propertyID)

Bases: DiscreteFunctionStageFactor

setPeakTensileStrengthFactor(value: float)

setResidualTensileStrengthFactor(value: float)

class rs2.modeler.properties.material.strength.DiscreteFunction.DiscreteFunction(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[DiscreteFunctionDefinedStageFactor, DiscreteFunctionStageFactor]

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setSelectedDiscreteFunctionByName(name: str)

getSelectedDiscreteFunctionName() → str

setProperties(ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.DoubleYieldStrength module

class rs2.modeler.properties.material.strength.DoubleYieldStrength.DoubleYieldStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getCap() → CySoilCapOption

setCap(value: CySoilCapOption)

getAlfaCap() → float

setAlfaCap(value: float)

getNormallyConsolidatedCapPressure() → float

setNormallyConsolidatedCapPressure(value: float)

getFrictionAngleFailure() → float

setFrictionAngleFailure(value: float)

getCohesion() → float

setCohesion(value: float)

getFailureRatio() → float

setFailureRatio(value: float)

getFrictionAngleNormallyConsolidated() → float

setFrictionAngleNormallyConsolidated(value: float)

getBetaShearCalibrationFactor() → float

setBetaShearCalibrationFactor(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getDilationOption() → DilationOption

setDilationOption(value: DilationOption)

getConstantVolumeFrictionAngle() → float

setConstantVolumeFrictionAngle(value: float)

setProperties(Cap: CySoilCapOption = None, AlfaCap: float = None, NormallyConsolidatedCapPressure: float = None, FrictionAngleFailure: float = None, Cohesion: float = None, FailureRatio: float = None, FrictionAngleNormallyConsolidated: float = None, BetaShearCalibrationFactor: float = None, TensileStrength: float = None, DilationAngle: float = None, DilationOption: DilationOption = None, ConstantVolumeFrictionAngle: float = None)

getProperties()

rs2.modeler.properties.material.strength.DruckerPrager module

class rs2.modeler.properties.material.strength.DruckerPrager.DruckerPragerStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getDilationParameterFactor() → float

getPeakKParameterFactor() → float

getResidualKParameterFactor() → float

getPeakTensileStrengthFactor() → float

getPeakQParameterFactor() → float

getResidualQParameterFactor() → float

getResidualTensileStrengthFactor() → float

class rs2.modeler.properties.material.strength.DruckerPrager.DruckerPragerDefinedStageFactor(client: Client, ID, propertyID)

Bases: DruckerPragerStageFactor

setDilationParameterFactor(value: float)

setPeakKParameterFactor(value: float)

setResidualKParameterFactor(value: float)

setPeakTensileStrengthFactor(value: float)

setPeakQParameterFactor(value: float)

setResidualQParameterFactor(value: float)

setResidualTensileStrengthFactor(value: float)

class rs2.modeler.properties.material.strength.DruckerPrager.DruckerPrager(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[DruckerPragerDefinedStageFactor, DruckerPragerStageFactor]

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getPeakQParameter() → float

setPeakQParameter(value: float)

getPeakKParameter() → float

setPeakKParameter(value: float)

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getResidualQParameter() → float

setResidualQParameter(value: float)

getResidualKParameter() → float

setResidualKParameter(value: float)

getResidualTensileStrength() → float

setResidualTensileStrength(value: float)

getDilationParameter() → float

setDilationParameter(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setProperties(MaterialType: MaterialType = None, PeakQParameter: float = None, PeakKParameter: float = None, PeakTensileStrength: float = None, ResidualQParameter: float = None, ResidualKParameter: float = None, ResidualTensileStrength: float = None, DilationParameter: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.Finn module

class rs2.modeler.properties.material.strength.Finn.Finn(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getPeakCohesion() → float

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

getFinnFormulation() → FinnFormula

setFinnFormulation(value: FinnFormula)

getC1Parameter() → float

setC1Parameter(value: float)

getC2Parameter() → float

setC2Parameter(value: float)

getC3Parameter() → float

setC3Parameter(value: float)

getC4Parameter() → float

setC4Parameter(value: float)

getByrneDefinition() → FinnByrneDefinition

setByrneDefinition(value: FinnByrneDefinition)

getFinnByrneC1Parameter() → float

setFinnByrneC1Parameter(value: float)

getFinnByrneC2Parameter() → float

setFinnByrneC2Parameter(value: float)

getN160() → int

setN160(value: int)

setProperties(PeakTensileStrength: float = None, PeakFrictionAngle: float = None, PeakCohesion: float = None, ResidualTensileStrength: float = None, ResidualFrictionAngle: float = None, ResidualCohesion: float = None, DilationAngle: float = None, ApplySSRShearStrengthReduction: bool = None, FinnFormulation: FinnFormula = None, C1Parameter: float = None, C2Parameter: float = None, C3Parameter: float = None, C4Parameter: float = None, ByrneDefinition: FinnByrneDefinition = None, FinnByrneC1Parameter: float = None, FinnByrneC2Parameter: float = None, N160: int = None)

getProperties()

rs2.modeler.properties.material.strength.GeneralizedAnisotropic module

class rs2.modeler.properties.material.strength.GeneralizedAnisotropic.GeneralizedAnisotropic(server: Client, ID, documentProxyID)

Bases: PropertyProxy

setGeneralizedAnisotropicFunction(generalizedFunction: list[tuple[float, str]])

Takes a list of tuples (angle, materialPropertyName). First angle must be greater than -90. Last angle must be exactly 90.

getGeneralizedAnisotropicFunction() → list[tuple[float, str]]

Returns a list of tuples (angle, materialPropertyName)

setBaseMaterialByName(materialName: str)

getBaseMaterialName() → str

rs2.modeler.properties.material.strength.GeneralizedHoekBrown module

class rs2.modeler.properties.material.strength.GeneralizedHoekBrown.GeneralizedHoekBrownStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getAParameterFactor() → float

getResidualAParameterFactor() → float

getCompressiveStrengthFactor() → float

getDilationParameterFactor() → float

getMbParameterFactor() → float

getResidualMbParameterFactor() → float

getHoekMartinMiFactor() → float

getSParameterFactor() → float

getResidualSParameterFactor() → float

getTensileCutoffFactor() → float

class rs2.modeler.properties.material.strength.GeneralizedHoekBrown.GeneralizedHoekBrownDefinedStageFactor(client: Client, ID, propertyID)

Bases: GeneralizedHoekBrownStageFactor

setAParameterFactor(value: float)

setResidualAParameterFactor(value: float)

setCompressiveStrengthFactor(value: float)

setDilationParameterFactor(value: float)

setMbParameterFactor(value: float)

setResidualMbParameterFactor(value: float)

setHoekMartinMiFactor(value: float)

setSParameterFactor(value: float)

setResidualSParameterFactor(value: float)

setTensileCutoffFactor(value: float)

class rs2.modeler.properties.material.strength.GeneralizedHoekBrown.GeneralizedHoekBrown(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[JointedGeneralizedHoekBrownDefinedStageFactor, JointedGeneralizedHoekBrownStageFactor]

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getCompressiveStrength() → float

setCompressiveStrength(value: float)

getMbParameter() → float

setMbParameter(value: float)

getSParameter() → float

setSParameter(value: float)

getAParameter() → float

setAParameter(value: float)

getGSIParameter() → float

setGSIParameter(value: float)

getMiParameter() → float

setMiParameter(value: float)

getDParameter() → float

setDParameter(value: float)

getResidualMbParameter() → float

setResidualMbParameter(value: float)

getResidualSParameter() → float

setResidualSParameter(value: float)

getResidualAParameter() → float

setResidualAParameter(value: float)

getResidualGSIParameter() → float

setResidualGSIParameter(value: float)

getResidualMiParameter() → float

setResidualMiParameter(value: float)

getResidualDParameter() → float

setResidualDParameter(value: float)

getDilationParameter() → float

setDilationParameter(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

getTensileCutoffType() → TensileCutoffOptions

setTensileCutoffType(value: TensileCutoffOptions)

getTensileCutoff() → float

setTensileCutoff(value: float)

getHoekMartinMi() → float

setHoekMartinMi(value: float)

setProperties(MaterialType: MaterialType = None, CompressiveStrength: float = None, MbParameter: float = None, SParameter: float = None, AParameter: float = None, GSIParameter: float = None, MiParameter: float = None, DParameter: float = None, ResidualMbParameter: float = None, ResidualSParameter: float = None, ResidualAParameter: float = None, ResidualGSIParameter: float = None, ResidualMiParameter: float = None, ResidualDParameter: float = None, DilationParameter: float = None, ApplySSRShearStrengthReduction: bool = None, TensileCutoffType: TensileCutoffOptions = None, TensileCutoff: float = None, HoekMartinMi: float = None)

getProperties()

rs2.modeler.properties.material.strength.HardeningSoilStrength module

class rs2.modeler.properties.material.strength.HardeningSoilStrength.HardeningSoilStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getFrictionAngle() → float

setFrictionAngle(value: float)

getCohesion() → float

setCohesion(value: float)

getFailureRatio() → float

setFailureRatio(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getDilationOption() → DilationOption

setDilationOption(value: DilationOption)

getDilatancyCutoff() → Dilatancy

setDilatancyCutoff(value: Dilatancy)

getE0() → float

setE0(value: float)

getEmax() → float

setEmax(value: float)

getK0NormalConsolidation() → float

setK0NormalConsolidation(value: float)

getInitialConsolidationCondition() → InitialConsolidation

setInitialConsolidationCondition(value: InitialConsolidation)

getOCRStress() → float

setOCRStress(value: float)

getInitialMeanStress() → float

setInitialMeanStress(value: float)

setProperties(FrictionAngle: float = None, Cohesion: float = None, FailureRatio: float = None, TensileStrength: float = None, DilationAngle: float = None, DilationOption: DilationOption = None, DilatancyCutoff: Dilatancy = None, E0: float = None, Emax: float = None, K0NormalConsolidation: float = None, InitialConsolidationCondition: InitialConsolidation = None, OCRStress: float = None, InitialMeanStress: float = None)

getProperties()

rs2.modeler.properties.material.strength.HardeningSoilWithSmallStrainStiffness module

class rs2.modeler.properties.material.strength.HardeningSoilWithSmallStrainStiffness.HardeningSoilWithSmallStrainStiffness(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getFrictionAngle() → float

setFrictionAngle(value: float)

getCohesion() → float

setCohesion(value: float)

getFailureRatio() → float

setFailureRatio(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getDilationOption() → DilationOption

setDilationOption(value: DilationOption)

getDilatancyCutoff() → Dilatancy

setDilatancyCutoff(value: Dilatancy)

getE0() → float

setE0(value: float)

getEmax() → float

setEmax(value: float)

getK0NormalConsolidation() → float

setK0NormalConsolidation(value: float)

getInitialConsolidationCondition() → InitialConsolidation

setInitialConsolidationCondition(value: InitialConsolidation)

getOCRStress() → float

setOCRStress(value: float)

getInitialMeanStress() → float

setInitialMeanStress(value: float)

setProperties(FrictionAngle: float = None, Cohesion: float = None, FailureRatio: float = None, TensileStrength: float = None, DilationAngle: float = None, DilationOption: DilationOption = None, DilatancyCutoff: Dilatancy = None, E0: float = None, Emax: float = None, K0NormalConsolidation: float = None, InitialConsolidationCondition: InitialConsolidation = None, OCRStress: float = None, InitialMeanStress: float = None)

getProperties()

rs2.modeler.properties.material.strength.HoekBrown module

class rs2.modeler.properties.material.strength.HoekBrown.HoekBrownStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getCompressiveStrengthFactor() → float

getDilationParameterFactor() → float

getMbParameterFactor() → float

getResidualMbParameterFactor() → float

getSParameterFactor() → float

getResidualSParameterFactor() → float

class rs2.modeler.properties.material.strength.HoekBrown.HoekBrownDefinedStageFactor(client: Client, ID, propertyID)

Bases: HoekBrownStageFactor

setCompressiveStrengthFactor(value: float)

setDilationParameterFactor(value: float)

setMbParameterFactor(value: float)

setResidualMbParameterFactor(value: float)

setSParameterFactor(value: float)

setResidualSParameterFactor(value: float)

class rs2.modeler.properties.material.strength.HoekBrown.HoekBrown(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[HoekBrownDefinedStageFactor, HoekBrownStageFactor]

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getCompressiveStrength() → float

setCompressiveStrength(value: float)

getMbParameter() → float

setMbParameter(value: float)

getSParameter() → float

setSParameter(value: float)

getResidualMbParameter() → float

setResidualMbParameter(value: float)

getResidualSParameter() → float

setResidualSParameter(value: float)

getDilationParameter() → float

setDilationParameter(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setProperties(MaterialType: MaterialType = None, CompressiveStrength: float = None, MbParameter: float = None, SParameter: float = None, ResidualMbParameter: float = None, ResidualSParameter: float = None, DilationParameter: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.Hyperbolic module

class rs2.modeler.properties.material.strength.Hyperbolic.Hyperbolic(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getPeakCohesion() → float

setPeakCohesion(value: float)

getResidualFrictionAngle() → float

setResidualFrictionAngle(value: float)

getResidualCohesion() → float

setResidualCohesion(value: float)

getDilationRatio() → float

setDilationRatio(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setProperties(MaterialType: MaterialType = None, PeakFrictionAngle: float = None, PeakCohesion: float = None, ResidualFrictionAngle: float = None, ResidualCohesion: float = None, DilationRatio: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.JointedGeneralizedHoekBrown module

class rs2.modeler.properties.material.strength.JointedGeneralizedHoekBrown.JointedGeneralizedHoekBrownStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getAParameterFactor() → float

getResidualAParameterFactor() → float

getCompressiveStrengthFactor() → float

getDilationParameterFactor() → float

getMbParameterFactor() → float

getResidualMbParameterFactor() → float

getHoekMartinMiFactor() → float

getSParameterFactor() → float

getResidualSParameterFactor() → float

getTensileCutoffFactor() → float

class rs2.modeler.properties.material.strength.JointedGeneralizedHoekBrown.JointedGeneralizedHoekBrownDefinedStageFactor(client: Client, ID, propertyID)

Bases: JointedGeneralizedHoekBrownStageFactor

setAParameterFactor(value: float)

setResidualAParameterFactor(value: float)

setCompressiveStrengthFactor(value: float)

setDilationParameterFactor(value: float)

setMbParameterFactor(value: float)

setResidualMbParameterFactor(value: float)

setHoekMartinMiFactor(value: float)

setSParameterFactor(value: float)

setResidualSParameterFactor(value: float)

setTensileCutoffFactor(value: float)

class rs2.modeler.properties.material.strength.JointedGeneralizedHoekBrown.JointedGeneralizedHoekBrown(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[JointedGeneralizedHoekBrownDefinedStageFactor, JointedGeneralizedHoekBrownStageFactor]

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getCompressiveStrength() → float

setCompressiveStrength(value: float)

getMbParameter() → float

setMbParameter(value: float)

getSParameter() → float

setSParameter(value: float)

getAParameter() → float

setAParameter(value: float)

getGSIParameter() → float

setGSIParameter(value: float)

getMiParameter() → float

setMiParameter(value: float)

getDParameter() → float

setDParameter(value: float)

getTensileCutoffType() → TensileCutoffOptions

setTensileCutoffType(value: TensileCutoffOptions)

getTensileCutoff() → float

setTensileCutoff(value: float)

getHoekMartinMi() → float

setHoekMartinMi(value: float)

getResidualMbParameter() → float

setResidualMbParameter(value: float)

getResidualSParameter() → float

setResidualSParameter(value: float)

getResidualAParameter() → float

setResidualAParameter(value: float)

getResidualGSIParameter() → float

setResidualGSIParameter(value: float)

getResidualMiParameter() → float

setResidualMiParameter(value: float)

getResidualDParameter() → float

setResidualDParameter(value: float)

getDilationParameter() → float

setDilationParameter(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

getJointOptions() → MaterialJointOptions

setProperties(MaterialType: MaterialType = None, CompressiveStrength: float = None, MbParameter: float = None, SParameter: float = None, AParameter: float = None, GSIParameter: float = None, MiParameter: float = None, DParameter: float = None, TensileCutoffType: TensileCutoffOptions = None, TensileCutoff: float = None, HoekMartinMi: float = None, ResidualMbParameter: float = None, ResidualSParameter: float = None, ResidualAParameter: float = None, ResidualGSIParameter: float = None, ResidualMiParameter: float = None, ResidualDParameter: float = None, DilationParameter: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.JointedMohrCoulomb module

class rs2.modeler.properties.material.strength.JointedMohrCoulomb.JointedMohrCoulombStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getResidualCohesionFactor() → float

getDilationAngleFactor() → float

getResidualFrictionAngleFactor() → float

getPeakCohesionFactor() → float

getPeakFrictionAngleFactor() → float

getPeakTensileStrengthFactor() → float

getResidualTensileStrengthFactor() → float

class rs2.modeler.properties.material.strength.JointedMohrCoulomb.JointedMohrCoulombDefinedStageFactor(client: Client, ID, propertyID)

Bases: JointedMohrCoulombStageFactor

setResidualCohesionFactor(value: float)

setDilationAngleFactor(value: float)

setResidualFrictionAngleFactor(value: float)

setPeakCohesionFactor(value: float)

setPeakFrictionAngleFactor(value: float)

setPeakTensileStrengthFactor(value: float)

setResidualTensileStrengthFactor(value: float)

class rs2.modeler.properties.material.strength.JointedMohrCoulomb.JointedMohrCoulomb(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[JointedMohrCoulombDefinedStageFactor, JointedMohrCoulombStageFactor]

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getPeakCohesion() → float

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

getJointOptions() → MaterialJointOptions

setProperties(MaterialType: MaterialType = None, PeakTensileStrength: float = None, PeakFrictionAngle: float = None, PeakCohesion: float = None, ResidualTensileStrength: float = None, ResidualFrictionAngle: float = None, ResidualCohesion: float = None, DilationAngle: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.ManzariAndDafaliasStrength module

class rs2.modeler.properties.material.strength.ManzariAndDafaliasStrength.ManzariAndDafaliasStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getCriticalStateM() → float

setCriticalStateM(value: float)

getCParameter() → float

setCParameter(value: float)

getLambdaC() → float

setLambdaC(value: float)

getE0Parameter() → float

setE0Parameter(value: float)

getXiParameter() → float

setXiParameter(value: float)

getYieldSurfaceM() → float

setYieldSurfaceM(value: float)

getH0Parameter() → float

setH0Parameter(value: float)

getChParameter() → float

setChParameter(value: float)

getNbParameter() → float

setNbParameter(value: float)

getA0Parameter() → float

setA0Parameter(value: float)

getNdParameter() → float

setNdParameter(value: float)

getZmax() → float

setZmax(value: float)

getCzParameter() → float

setCzParameter(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setProperties(CriticalStateM: float = None, CParameter: float = None, LambdaC: float = None, E0Parameter: float = None, XiParameter: float = None, YieldSurfaceM: float = None, H0Parameter: float = None, ChParameter: float = None, NbParameter: float = None, A0Parameter: float = None, NdParameter: float = None, Zmax: float = None, CzParameter: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.ModifiedCamClay module

class rs2.modeler.properties.material.strength.ModifiedCamClay.ModifiedCamClayStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getCriticalStateSlopeFactor() → float

getGammaFactor() → float

getKappaFactor() → float

getLambdaFactor() → float

getNParameterFactor() → float

getOverconsolidationRatioFactor() → float

getPreconsolidationStressFactor() → float

class rs2.modeler.properties.material.strength.ModifiedCamClay.ModifiedCamClayDefinedStageFactor(client: Client, ID, propertyID)

Bases: ModifiedCamClayStageFactor

setCriticalStateSlopeFactor(value: float)

setGammaFactor(value: float)

setKappaFactor(value: float)

setLambdaFactor(value: float)

setNParameterFactor(value: float)

setOverconsolidationRatioFactor(value: float)

setPreconsolidationStressFactor(value: float)

class rs2.modeler.properties.material.strength.ModifiedCamClay.ModifiedCamClay(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[ModifiedCamClayDefinedStageFactor, ModifiedCamClayStageFactor]

getCriticalStateSlope() → float

setCriticalStateSlope(value: float)

getSpecificVolumeAtUnitPressure() → SpecificVolumeAtUnitPressure

setSpecificVolumeAtUnitPressure(value: SpecificVolumeAtUnitPressure)

getNParameter() → float

setNParameter(value: float)

getGamma() → float

setGamma(value: float)

getKappa() → float

setKappa(value: float)

getInitialStateOfConsolidation() → InitialStateOfConsolidation

setInitialStateOfConsolidation(value: InitialStateOfConsolidation)

getOverconsolidationRatio() → float

setOverconsolidationRatio(value: float)

getPreconsolidationStress() → float

setPreconsolidationStress(value: float)

getLambda() → float

setLambda(value: float)

setProperties(CriticalStateSlope: float = None, SpecificVolumeAtUnitPressure: SpecificVolumeAtUnitPressure = None, NParameter: float = None, Gamma: float = None, Kappa: float = None, InitialStateOfConsolidation: InitialStateOfConsolidation = None, OverconsolidationRatio: float = None, PreconsolidationStress: float = None, Lambda: float = None)

getProperties()

rs2.modeler.properties.material.strength.MohrCoulombStrength module

class rs2.modeler.properties.material.strength.MohrCoulombStrength.MohrCoulombStrengthStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getResidualCohesionFactor() → float

getDilationAngleFactor() → float

getResidualFrictionAngleFactor() → float

getPeakCohesionFactor() → float

getPeakFrictionAngleFactor() → float

getPeakTensileStrengthFactor() → float

getResidualTensileStrengthFactor() → float

class rs2.modeler.properties.material.strength.MohrCoulombStrength.MohrCoulombStrengthDefinedStageFactor(client: Client, ID, propertyID)

Bases: MohrCoulombStrengthStageFactor

setResidualCohesionFactor(value: float)

setDilationAngleFactor(value: float)

setResidualFrictionAngleFactor(value: float)

setPeakCohesionFactor(value: float)

setPeakFrictionAngleFactor(value: float)

setPeakTensileStrengthFactor(value: float)

setResidualTensileStrengthFactor(value: float)

class rs2.modeler.properties.material.strength.MohrCoulombStrength.MohrCoulombStrength(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[MohrCoulombStrengthDefinedStageFactor, MohrCoulombStrengthStageFactor]

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getPeakCohesion() → float

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

setProperties(MaterialType: MaterialType = None, PeakTensileStrength: float = None, PeakFrictionAngle: float = None, PeakCohesion: float = None, ResidualTensileStrength: float = None, ResidualFrictionAngle: float = None, ResidualCohesion: float = None, DilationAngle: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.MohrCoulombWithCap module

class rs2.modeler.properties.material.strength.MohrCoulombWithCap.MohrCoulombWithCapStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getDilationAngleFactor() → float

getInitialMeanStressFactor() → float

getLambdaKappaFactor() → float

getPeakCohesionFactor() → float

getPeakFrictionAngleFactor() → float

getPeakTensileStrengthFactor() → float

class rs2.modeler.properties.material.strength.MohrCoulombWithCap.MohrCoulombWithCapDefinedStageFactor(client: Client, ID, propertyID)

Bases: MohrCoulombWithCapStageFactor

setDilationAngleFactor(value: float)

setInitialMeanStressFactor(value: float)

setLambdaKappaFactor(value: float)

setPeakCohesionFactor(value: float)

setPeakFrictionAngleFactor(value: float)

setPeakTensileStrengthFactor(value: float)

class rs2.modeler.properties.material.strength.MohrCoulombWithCap.MohrCoulombWithCap(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[MohrCoulombWithCapDefinedStageFactor, MohrCoulombWithCapStageFactor]

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getPeakCohesion() → float

setPeakCohesion(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getCapType() → MCCapType

setCapType(value: MCCapType)

getCapHardeningType() → CapHardeningTypes

setCapHardeningType(value: CapHardeningTypes)

getInitialMeanStress() → float

setInitialMeanStress(value: float)

getLambdaKappa() → float

setLambdaKappa(value: float)

setMohrCoulombCapMeanStress(meanStress: list[tuple[float, float]])

meanStress is a list of (x,y) tuples.

getMohrCoulombCapMeanStress() → list[tuple[float, float]]

returns a list of (x,y) tuples.

setProperties(PeakTensileStrength: float = None, PeakFrictionAngle: float = None, PeakCohesion: float = None, DilationAngle: float = None, CapType: MCCapType = None, CapHardeningType: CapHardeningTypes = None, InitialMeanStress: float = None, LambdaKappa: float = None)

getProperties()

rs2.modeler.properties.material.strength.NorSandStrength module

class rs2.modeler.properties.material.strength.NorSandStrength.NorSandStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getMTCCriticalFrictionRatio() → float

setMTCCriticalFrictionRatio(value: float)

getLambdaSlopeOfCSLNaturalLog() → float

setLambdaSlopeOfCSLNaturalLog(value: float)

getH0PlasticHardeningModulus() → float

setH0PlasticHardeningModulus(value: float)

getChiTCDilationCoefficient() → float

setChiTCDilationCoefficient(value: float)

getNVolumetricCouplingCoefficient() → float

setNVolumetricCouplingCoefficient(value: float)

getHyChangeInHardeningModulus() → float

setHyChangeInHardeningModulus(value: float)

getPsi0InitialStateParameter() → float

setPsi0InitialStateParameter(value: float)

getGamaAltitudeOfCSLAt1KPa() → float

setGamaAltitudeOfCSLAt1KPa(value: float)

getInitialConsolidationCondition() → NorSandInitialConsolidationCondition

setInitialConsolidationCondition(value: NorSandInitialConsolidationCondition)

getOCR() → float

setOCR(value: float)

getInitialMeanStress() → float

setInitialMeanStress(value: float)

getCapSoftening() → bool

setCapSoftening(value: bool)

getNorSandFluidBulkModulus() → float

setNorSandFluidBulkModulus(value: float)

setProperties(MTCCriticalFrictionRatio: float = None, LambdaSlopeOfCSLNaturalLog: float = None, H0PlasticHardeningModulus: float = None, ChiTCDilationCoefficient: float = None, NVolumetricCouplingCoefficient: float = None, HyChangeInHardeningModulus: float = None, Psi0InitialStateParameter: float = None, GamaAltitudeOfCSLAt1KPa: float = None, InitialConsolidationCondition: NorSandInitialConsolidationCondition = None, OCR: float = None, InitialMeanStress: float = None, CapSoftening: bool = None, NorSandFluidBulkModulus: float = None)

getProperties()

rs2.modeler.properties.material.strength.PM4SandStrength module

class rs2.modeler.properties.material.strength.PM4SandStrength.PM4SandStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getDr() → float

setDr(value: float)

getQParameter() → float

setQParameter(value: float)

getRParameter() → float

setRParameter(value: float)

getEMax() → float

setEMax(value: float)

getEMin() → float

setEMin(value: float)

getPhiCv() → float

setPhiCv(value: float)

getNbParameter() → float

setNbParameter(value: float)

getNdParameter() → float

setNdParameter(value: float)

getAutoCalculateADoParameter() → bool

setAutoCalculateADoParameter(value: bool)

getADoParameter() → float

setADoParameter(value: float)

getHp0Parameter() → float

setHp0Parameter(value: float)

getAutoCalculateCDRParameter() → bool

setAutoCalculateCDRParameter(value: bool)

getCDRParameter() → float

setCDRParameter(value: float)

getAutoCalculateCEpsParameter() → bool

setAutoCalculateCEpsParameter(value: bool)

getCEpsParameter() → float

setCEpsParameter(value: float)

getYieldSurfaceM() → float

setYieldSurfaceM(value: float)

getAutoCalculateH0Parameter() → bool

setAutoCalculateH0Parameter(value: bool)

getH0Parameter() → float

setH0Parameter(value: float)

getAutoCalculateCKafParameter() → bool

setAutoCalculateCKafParameter(value: bool)

getCKafParameter() → float

setCKafParameter(value: float)

getAutoCalculateZmax() → bool

setAutoCalculateZmax(value: bool)

getZmax() → float

setZmax(value: float)

getAutoCalculateCzParameter() → bool

setAutoCalculateCzParameter(value: bool)

getCzParameter() → float

setCzParameter(value: float)

setProperties(Dr: float = None, QParameter: float = None, RParameter: float = None, EMax: float = None, EMin: float = None, PhiCv: float = None, NbParameter: float = None, NdParameter: float = None, AutoCalculateADoParameter: bool = None, ADoParameter: float = None, Hp0Parameter: float = None, AutoCalculateCDRParameter: bool = None, CDRParameter: float = None, AutoCalculateCEpsParameter: bool = None, CEpsParameter: float = None, YieldSurfaceM: float = None, AutoCalculateH0Parameter: bool = None, H0Parameter: float = None, AutoCalculateCKafParameter: bool = None, CKafParameter: float = None, AutoCalculateZmax: bool = None, Zmax: float = None, AutoCalculateCzParameter: bool = None, CzParameter: float = None)

getProperties()

rs2.modeler.properties.material.strength.PM4SiltStrength module

class rs2.modeler.properties.material.strength.PM4SiltStrength.PM4SiltStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getAutoCalculateSuParameter() → bool

setAutoCalculateSuParameter(value: bool)

getSuParameter() → float

setSuParameter(value: float)

getSuRatioParameter() → float

setSuRatioParameter(value: float)

getAutoCalculateEInitial() → bool

setAutoCalculateEInitial(value: bool)

getEInitial() → float

setEInitial(value: float)

getAutoCalculateLambda() → bool

setAutoCalculateLambda(value: bool)

getLambda() → float

setLambda(value: float)

getAutoCalculateFsu() → bool

setAutoCalculateFsu(value: bool)

getFsu() → float

setFsu(value: float)

getAutoCalculatePhiCv() → bool

setAutoCalculatePhiCv(value: bool)

getPhiCv() → float

setPhiCv(value: float)

getAutoCalculateNbWet() → bool

setAutoCalculateNbWet(value: bool)

getNbWet() → float

setNbWet(value: float)

getAutoCalculateNbDry() → bool

setAutoCalculateNbDry(value: bool)

getNbDry() → float

setNbDry(value: float)

getAutoCalculateNdParameter() → bool

setAutoCalculateNdParameter(value: bool)

getNdParameter() → float

setNdParameter(value: float)

getAutoCalculateADoParameter() → bool

setAutoCalculateADoParameter(value: bool)

getADoParameter() → float

setADoParameter(value: float)

getAutoCalculateRuMax() → bool

setAutoCalculateRuMax(value: bool)

getRuMax() → float

setRuMax(value: float)

getHp0Parameter() → float

setHp0Parameter(value: float)

getAutoCalculateCEpsParameter() → bool

setAutoCalculateCEpsParameter(value: bool)

getCEpsParameter() → float

setCEpsParameter(value: float)

getYieldSurfaceM() → float

setYieldSurfaceM(value: float)

getAutoCalculateH0Parameter() → bool

setAutoCalculateH0Parameter(value: bool)

getH0Parameter() → float

setH0Parameter(value: float)

getAutoCalculateCKafParameter() → bool

setAutoCalculateCKafParameter(value: bool)

getCKafParameter() → float

setCKafParameter(value: float)

getAutoCalculateZmax() → bool

setAutoCalculateZmax(value: bool)

getZmax() → float

setZmax(value: float)

getAutoCalculateCzParameter() → bool

setAutoCalculateCzParameter(value: bool)

getCzParameter() → float

setCzParameter(value: float)

setProperties(AutoCalculateSuParameter: bool = None, SuParameter: float = None, SuRatioParameter: float = None, AutoCalculateEInitial: bool = None, EInitial: float = None, AutoCalculateLambda: bool = None, Lambda: float = None, AutoCalculateFsu: bool = None, Fsu: float = None, AutoCalculatePhiCv: bool = None, PhiCv: float = None, AutoCalculateNbWet: bool = None, NbWet: float = None, AutoCalculateNbDry: bool = None, NbDry: float = None, AutoCalculateNdParameter: bool = None, NdParameter: float = None, AutoCalculateADoParameter: bool = None, ADoParameter: float = None, AutoCalculateRuMax: bool = None, RuMax: float = None, Hp0Parameter: float = None, AutoCalculateCEpsParameter: bool = None, CEpsParameter: float = None, YieldSurfaceM: float = None, AutoCalculateH0Parameter: bool = None, H0Parameter: float = None, AutoCalculateCKafParameter: bool = None, CKafParameter: float = None, AutoCalculateZmax: bool = None, Zmax: float = None, AutoCalculateCzParameter: bool = None, CzParameter: float = None)

getProperties()

rs2.modeler.properties.material.strength.PowerCurve module

class rs2.modeler.properties.material.strength.PowerCurve.PowerCurve(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getAParameter() → float

setAParameter(value: float)

getBParameter() → float

setBParameter(value: float)

getCParameter() → float

setCParameter(value: float)

getDParameter() → float

setDParameter(value: float)

getWaviness() → float

setWaviness(value: float)

getResidualAParameter() → float

setResidualAParameter(value: float)

getResidualBParameter() → float

setResidualBParameter(value: float)

getResidualCParameter() → float

setResidualCParameter(value: float)

getResidualDParameter() → float

setResidualDParameter(value: float)

getResidualWaviness() → float

setResidualWaviness(value: float)

getDilationRatio() → float

setDilationRatio(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setProperties(MaterialType: MaterialType = None, AParameter: float = None, BParameter: float = None, CParameter: float = None, DParameter: float = None, Waviness: float = None, ResidualAParameter: float = None, ResidualBParameter: float = None, ResidualCParameter: float = None, ResidualDParameter: float = None, ResidualWaviness: float = None, DilationRatio: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.Shansep module

class rs2.modeler.properties.material.strength.Shansep.Shansep(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getUseMaterialDependentStress() → bool

setUseMaterialDependentStress(value: bool)

getUseMaximumShearStrength() → bool

setUseMaximumShearStrength(value: bool)

getUseTensileStrength() → bool

setUseTensileStrength(value: bool)

getAParameter() → float

setAParameter(value: float)

getSParameter() → float

setSParameter(value: float)

getMParameter() → float

setMParameter(value: float)

getMaximumShearStrength() → float

setMaximumShearStrength(value: float)

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getResidualAParameter() → float

setResidualAParameter(value: float)

getResidualSParameter() → float

setResidualSParameter(value: float)

getResidualMParameter() → float

setResidualMParameter(value: float)

getResidualMaximumShearStrength() → float

setResidualMaximumShearStrength(value: float)

getResidualTensileStrength() → float

setResidualTensileStrength(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

getStressHistoryType() → StressHistoryTypes

setStressHistoryType(value: StressHistoryTypes)

getOCRDefinitionMethod() → StressHistoryDefinitionMethods

setOCRDefinitionMethod(value: StressHistoryDefinitionMethods)

getOCR() → float

setOCR(value: float)

getPcDefinitionMethod() → StressHistoryDefinitionMethods

setPcDefinitionMethod(value: StressHistoryDefinitionMethods)

getPc() → float

setPc(value: float)

setShansepMaterialDependentVerticalStress(materialDependentVerticalStress: list[tuple[str, float]])

materialDependentVerticalStress is a list of (materialName,verticalStressFactor) pairs.

A factor of 1 means that the entire weight is used in the vertical stress computation. A factor of 0 means no weight is used. If a material is not provided, it automatically has a factor of 1.

getShansepMaterialDependentVerticalStress() → list[tuple[str, float]]

returns a list of (materialName,verticalStressFactor) pairs.

A factor of 1 means that the entire weight is used in the vertical stress computation. A factor of 0 means no weight is used. If a material is not listed below it automatically has a factor of 1.

setShansepStressHistory(stressHistory: list[tuple[float, float]])

Depending on the stressHistory type and definition method, stressHistory is specified as (Depth or Elevation, OCR or Pc).

getShansepStressHistory() → list[tuple[float, float]]

Returns the Stress History. Depending on the stressHistory type and definition method, stressHistory is specified as a list of tuples (Depth or Elevation, OCR or Pc).

setProperties(MaterialType: MaterialType = None, UseMaterialDependentStress: bool = None, UseMaximumShearStrength: bool = None, UseTensileStrength: bool = None, AParameter: float = None, SParameter: float = None, MParameter: float = None, MaximumShearStrength: float = None, PeakTensileStrength: float = None, ResidualAParameter: float = None, ResidualSParameter: float = None, ResidualMParameter: float = None, ResidualMaximumShearStrength: float = None, ResidualTensileStrength: float = None, ApplySSRShearStrengthReduction: bool = None, StressHistoryType: StressHistoryTypes = None, OCRDefinitionMethod: StressHistoryDefinitionMethods = None, OCR: float = None, PcDefinitionMethod: StressHistoryDefinitionMethods = None, Pc: float = None)

getProperties()

rs2.modeler.properties.material.strength.ShearNormalFunction module

class rs2.modeler.properties.material.strength.ShearNormalFunction.ShearNormalFunction(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setShearNormalFunctionByName(name: str)

getShearNormalFunctionName() → str

setProperties(ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.SnowdenModAnisotropicLinear module

class rs2.modeler.properties.material.strength.SnowdenModAnisotropicLinear.SnowdenModAnisotropicLinear(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getA1Parameter() → float

setA1Parameter(value: float)

getA2Parameter() → float

setA2Parameter(value: float)

getB1Parameter() → float

setB1Parameter(value: float)

getB2Parameter() → float

setB2Parameter(value: float)

getAnisotropyDefinition() → AnisotropyDefinitions

setAnisotropyDefinition(value: AnisotropyDefinitions)

getAngleCcwTo1() → float

setAngleCcwTo1(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setAnisotropicSurfaceByName(surfaceName: str)

Sets the anisotropic surface by name. The surface must be defined in the model.

getAnisotropicSurfaceName() → str

getBeddingStrengthFunction() → SnowdenAnisotropicFunction

getRockMassStrengthFunction() → SnowdenAnisotropicFunction

setProperties(MaterialType: MaterialType = None, A1Parameter: float = None, A2Parameter: float = None, B1Parameter: float = None, B2Parameter: float = None, AnisotropyDefinition: AnisotropyDefinitions = None, AngleCcwTo1: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()

rs2.modeler.properties.material.strength.SoftSoilCreepStrength module

class rs2.modeler.properties.material.strength.SoftSoilCreepStrength.SoftSoilCreepStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getFrictionAngle() → float

setFrictionAngle(value: float)

getCohesion() → float

setCohesion(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getLambda() → float

setLambda(value: float)

getKappa() → float

setKappa(value: float)

getK0NormalConsolidation() → float

setK0NormalConsolidation(value: float)

getInitialConsolidationCondition() → InitialConsolidation

setInitialConsolidationCondition(value: InitialConsolidation)

getOCRStress() → float

setOCRStress(value: float)

getInitialMeanStress() → float

setInitialMeanStress(value: float)

getMu() → float

setMu(value: float)

setProperties(FrictionAngle: float = None, Cohesion: float = None, TensileStrength: float = None, DilationAngle: float = None, Lambda: float = None, Kappa: float = None, K0NormalConsolidation: float = None, InitialConsolidationCondition: InitialConsolidation = None, OCRStress: float = None, InitialMeanStress: float = None, Mu: float = None)

getProperties()

rs2.modeler.properties.material.strength.SoftSoilStrength module

class rs2.modeler.properties.material.strength.SoftSoilStrength.SoftSoilStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getFrictionAngle() → float

setFrictionAngle(value: float)

getCohesion() → float

setCohesion(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getLambda() → float

setLambda(value: float)

getKappa() → float

setKappa(value: float)

getK0NormalConsolidation() → float

setK0NormalConsolidation(value: float)

getInitialConsolidationCondition() → InitialConsolidation

setInitialConsolidationCondition(value: InitialConsolidation)

getOCRStress() → float

setOCRStress(value: float)

getInitialMeanStress() → float

setInitialMeanStress(value: float)

setProperties(FrictionAngle: float = None, Cohesion: float = None, TensileStrength: float = None, DilationAngle: float = None, Lambda: float = None, Kappa: float = None, K0NormalConsolidation: float = None, InitialConsolidationCondition: InitialConsolidation = None, OCRStress: float = None, InitialMeanStress: float = None)

getProperties()

rs2.modeler.properties.material.strength.SofteningHardeningModel module

class rs2.modeler.properties.material.strength.SofteningHardeningModel.SofteningHardeningModelStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getHardeningPropertyFactor() → float

getInitialMeanStressFactor() → float

getLambdaKappaFactor() → float

getPeakCohesionFactor() → float

getPeakFrictionAngleFactor() → float

getPeakTensileStrengthFactor() → float

getDilationAngleFactor() → float

class rs2.modeler.properties.material.strength.SofteningHardeningModel.SofteningHardeningModelDefinedStageFactor(client: Client, ID, propertyID)

Bases: SofteningHardeningModelStageFactor

setHardeningPropertyFactor(value: float)

setInitialMeanStressFactor(value: float)

setLambdaKappaFactor(value: float)

setPeakCohesionFactor(value: float)

setPeakFrictionAngleFactor(value: float)

setPeakTensileStrengthFactor(value: float)

setDilationAngleFactor(value: float)

class rs2.modeler.properties.material.strength.SofteningHardeningModel.SofteningHardeningModel(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[SofteningHardeningModelDefinedStageFactor, SofteningHardeningModelStageFactor]

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getPeakFrictionAngle() → float

setPeakFrictionAngle(value: float)

getPeakCohesion() → float

setPeakCohesion(value: float)

getConeHardeningType() → ConeHardeningTypes

setConeHardeningType(value: ConeHardeningTypes)

getHardeningProperty() → float

setHardeningProperty(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getConeDilationType() → DilationTypes

setConeDilationType(value: DilationTypes)

getCapType() → CapTypes

setCapType(value: CapTypes)

getCapHardeningType() → CapHardeningTypes

setCapHardeningType(value: CapHardeningTypes)

getInitialMeanStress() → float

setInitialMeanStress(value: float)

getLambdaKappa() → float

setLambdaKappa(value: float)

setSHConeHardening(plasticStrainVsFrictionAngle: list[tuple[float, float]], plasticStrainVsCohesion: list[tuple[float, float]])

plasticStrainVsFrictionAngle: list of tuples, (plainStrain, frictionAngle) plasticStrainVsCohesion: list of tuples, (plasticStrain, Cohesion)

getSHConeHardening() → tuple[list[tuple[float, float]], list[tuple[float, float]]]

returns a tuple of (plasticStrainVsFrictionAngle, plasticStrainVsCohesion), where plasticStrainVsFrictionAngle: list of tuples, (plainStrain, frictionAngle) plasticStrainVsCohesion: list of tuples, (plasticStrain, Cohesion)

setSHCapMeanStress(meanStress: list[tuple[float, float]])

meanStress is a list of (x,y) tuples.

getSHCapMeanStress() → list[tuple[float, float]]

returns a list of (x,y) tuples.

setProperties(PeakTensileStrength: float = None, PeakFrictionAngle: float = None, PeakCohesion: float = None, ConeHardeningType: ConeHardeningTypes = None, HardeningProperty: float = None, DilationAngle: float = None, ConeDilationType: DilationTypes = None, CapType: CapTypes = None, CapHardeningType: CapHardeningTypes = None, InitialMeanStress: float = None, LambdaKappa: float = None)

getProperties()

rs2.modeler.properties.material.strength.Strength module

class rs2.modeler.properties.material.strength.Strength.StrengthStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getAirEntryValueFactor() → float

getUnsaturatedShearStrengthAngleFactor() → float

getResetYield() → bool

class rs2.modeler.properties.material.strength.Strength.StrengthDefinedStageFactor(client: Client, ID, propertyID)

Bases: StrengthStageFactor

setAirEntryValueFactor(value: float)

setUnsaturatedShearStrengthAngleFactor(value: float)

setResetYield(resetYield: bool)

class rs2.modeler.properties.material.strength.Strength.Strength(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Strength Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[StrengthDefinedStageFactor, StrengthStageFactor]

MohrCoulombStrength

Reference object for modifying property.

Type:

MohrCoulombStrength

HoekBrown

Reference object for modifying property.

Type:

HoekBrown

DruckerPrager

Reference object for modifying property.

Type:

DruckerPrager

GeneralizedHoekBrown

Reference object for modifying property.

Type:

GeneralizedHoekBrown

DiscreteFunction

Reference object for modifying property.

Type:

Strength.DiscreteFunction

CamClay

Reference object for modifying property.

Type:

CamClay

ModifiedCamClay

Reference object for modifying property.

Type:

ModifiedCamClay

MohrCoulombWithCap

Reference object for modifying property.

Type:

MohrCoulombWithCap

SofteningHardeningModel

Reference object for modifying property.

Type:

SofteningHardeningModel

BarcelonaBasic

Reference object for modifying property.

Type:

BarcelonaBasic

NorSandStrength

Reference object for modifying property.

Type:

NorSandStrength

BoundingSurfacePlasticity

Reference object for modifying property.

Type:

BoundingSurfacePlasticity

ManzariAndDafaliasStrength

Reference object for modifying property.

Type:

ManzariAndDafaliasStrength

PM4SandStrength

Reference object for modifying property.

Type:

PM4SandStrength

PM4SiltStrength

Reference object for modifying property.

Type:

PM4SiltStrength

Finn

Reference object for modifying property.

Type:

Finn

BartonBandisStrength

Reference object for modifying property.

Type:

BartonBandisStrength

Hyperbolic

Reference object for modifying property.

Type:

Hyperbolic

PowerCurve

Reference object for modifying property.

Type:

PowerCurve

ShearNormalFunction

Reference object for modifying property.

Type:

Strength.ShearNormalFunction

Shansep

Reference object for modifying property.

Type:

Shansep

VerticalStressRatio

Reference object for modifying property.

Type:

VerticalStressRatio

SnowdenModAnisotropicLinear

Reference object for modifying property.

Type:

SnowdenModAnisotropicLinear

AnisotropicLinear

Reference object for modifying property.

Type:

AnisotropicLinear

GeneralizedAnisotropic

Reference object for modifying property.

Type:

GeneralizedAnisotropic

JointedMohrCoulomb

Reference object for modifying property.

Type:

JointedMohrCoulomb

JointedGeneralizedHoekBrown

Reference object for modifying property.

Type:

JointedGeneralizedHoekBrown

ChSoilStrength

Reference object for modifying property.

Type:

ChSoilStrength

CySoilStrength

Reference object for modifying property.

Type:

CySoilStrength

DoubleYieldStrength

Reference object for modifying property.

Type:

DoubleYieldStrength

HardeningSoilStrength

Reference object for modifying property.

Type:

HardeningSoilStrength

HardeningSoilWithSmallStrainStiffness

Reference object for modifying property.

Type:

HardeningSoilWithSmallStrainStiffness

SoftSoilStrength

Reference object for modifying property.

Type:

SoftSoilStrength

SoftSoilCreepStrength

Reference object for modifying property.

Type:

SoftSoilCreepStrength

SwellingRockStrength

Reference object for modifying property.

Type:

SwellingRockStrength

getFailureCriterion() → StrengthCriteriaTypes

setFailureCriterion(value: StrengthCriteriaTypes)

getUnsaturatedBehavior() → UnsaturatedParameterType

setUnsaturatedBehavior(value: UnsaturatedParameterType)

getUnsaturatedShearStrengthType() → UnsaturatedShearStrengthType

setUnsaturatedShearStrengthType(value: UnsaturatedShearStrengthType)

getUnsaturatedShearStrengthAngle() → float

setUnsaturatedShearStrengthAngle(value: float)

getAirEntryValue() → float

setAirEntryValue(value: float)

getSingleEffectiveStressMethod() → UnsaturatedSingleEffectiveStressMethod

setSingleEffectiveStressMethod(value: UnsaturatedSingleEffectiveStressMethod)

getAlpha() → float

setAlpha(value: float)

getAirEntrySuction() → float

setAirEntrySuction(value: float)

getCriticalSuction() → float

setCriticalSuction(value: float)

getMaterialParameter() → float

setMaterialParameter(value: float)

getUseCutoff() → bool

setUseCutoff(value: bool)

getCutoffValue() → float

setCutoffValue(value: float)

getTabularValues() → UnsaturatedTabularValueMethod

setTabularValues(value: UnsaturatedTabularValueMethod)

setUnsaturatedZoneTableWithRespectToSuction(coefficients: list[float], values: list[float])

Specify the coefficient and values with respect to suction.

getUnsaturatedZoneTableWithRespectToSuction() → tuple[list[float], list[float]]

Returns a tuple of lists where the first element is coefficients and the second is values with respect to suction.

setUnsaturatedZoneTableWithRespectToDegreeOfSaturation(coefficients: list[float], values: list[float])

Specify the coefficient and values with respect to degree of saturation.

getUnsaturatedZoneTableWithRespectToDegreeOfSaturation() → list[tuple[float, float]]

Returns a tuple of lists where the first element is coefficients and the second is values with respect to degree of saturation.

setUnsaturatedZoneTableWithRespectToEffectiveDegreeOfSaturation(coefficients: list[float], values: list[float])

Specify the coefficient and values with respect to effective degree of saturation.

getUnsaturatedZoneTableWithRespectToEffectiveDegreeOfSaturation() → list[tuple[float, float]]

Returns a tuple of lists where the first element is coefficients and the second is values with respect to effective degree of saturation.

rs2.modeler.properties.material.strength.SwellingRockStrength module

class rs2.modeler.properties.material.strength.SwellingRockStrength.SwellingRockStrength(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getFrictionAngle() → float

setFrictionAngle(value: float)

getCohesion() → float

setCohesion(value: float)

getTensileStrength() → float

setTensileStrength(value: float)

getDilationAngle() → float

setDilationAngle(value: float)

getA0() → float

setA0(value: float)

getAElastic() → float

setAElastic(value: float)

getAPlastic() → float

setAPlastic(value: float)

getMaximumPlasticVolumetricStrainForAPlastic() → float

setMaximumPlasticVolumetricStrainForAPlastic(value: float)

getKSwellNormal() → float

setKSwellNormal(value: float)

getKSwellTangential() → float

setKSwellTangential(value: float)

getMaximumSwellingStressNormal() → float

setMaximumSwellingStressNormal(value: float)

getMaximumSwellingStressTangential() → float

setMaximumSwellingStressTangential(value: float)

getMinimumSwellingStress() → float

setMinimumSwellingStress(value: float)

getSwellingFormulation() → SwellingForm

setSwellingFormulation(value: SwellingForm)

getWaterCondition() → WaterCondition

setWaterCondition(value: WaterCondition)

getSigmaCoupling() → float

setSigmaCoupling(value: float)

setProperties(FrictionAngle: float = None, Cohesion: float = None, TensileStrength: float = None, DilationAngle: float = None, A0: float = None, AElastic: float = None, APlastic: float = None, MaximumPlasticVolumetricStrainForAPlastic: float = None, KSwellNormal: float = None, KSwellTangential: float = None, MaximumSwellingStressNormal: float = None, MaximumSwellingStressTangential: float = None, MinimumSwellingStress: float = None, SwellingFormulation: SwellingForm = None, WaterCondition: WaterCondition = None, SigmaCoupling: float = None)

getProperties()

rs2.modeler.properties.material.strength.VerticalStressRatio module

class rs2.modeler.properties.material.strength.VerticalStressRatio.VerticalStressRatio(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getMaterialType() → MaterialType

setMaterialType(value: MaterialType)

getUseMaximumShearStrength() → bool

setUseMaximumShearStrength(value: bool)

getUseTensileStrength() → bool

setUseTensileStrength(value: bool)

getVerticalStressRatio() → float

setVerticalStressRatio(value: float)

getMinimumShearStrength() → float

setMinimumShearStrength(value: float)

getMaximumShearStrength() → float

setMaximumShearStrength(value: float)

getPeakTensileStrength() → float

setPeakTensileStrength(value: float)

getResidualVerticalStressRatio() → float

setResidualVerticalStressRatio(value: float)

getResidualMinimumShearStrength() → float

setResidualMinimumShearStrength(value: float)

getResidualMaximumShearStrength() → float

setResidualMaximumShearStrength(value: float)

getResidualTensileStrength() → float

setResidualTensileStrength(value: float)

getApplySSRShearStrengthReduction() → bool

setApplySSRShearStrengthReduction(value: bool)

setProperties(MaterialType: MaterialType = None, UseMaximumShearStrength: bool = None, UseTensileStrength: bool = None, VerticalStressRatio: float = None, MinimumShearStrength: float = None, MaximumShearStrength: float = None, PeakTensileStrength: float = None, ResidualVerticalStressRatio: float = None, ResidualMinimumShearStrength: float = None, ResidualMaximumShearStrength: float = None, ResidualTensileStrength: float = None, ApplySSRShearStrengthReduction: bool = None)

getProperties()