MethodsProjectSettings#

class IntersliceForceFunctionType(*values)#

Bases: Enum

CONSTANT = 1#

TRAPEZOID = 2#

HALF_SINE = 3#

CLIPPED_SINE = 4#

USER_DEFINED = 5#

class SlicesType(*values)#

Bases: Enum

VERTICAL = 1#

NON_VERTICAL_SARMA = 2#

class SarmaIntersliceOption(*values)#

Bases: Enum

COMPUTED = 1#

USER_DEFINED = 2#

class SarmaSliceAngleOption(*values)#

Bases: Enum

OPTIMIZED = 1#

USER_DEFINED = 2#

class OptimizedSarmaSliceAnglesMethod(*values)#

Bases: Enum

GLOBAL_MINIMUM = 1#

ALL_SURFACES = 2#

class UserDefinedSarmaSliceAnglesMethod(*values)#

Bases: Enum

BISECTION = 3#

WEIGHTED_AVERAGE_NORMAL = 4#

VERTICAL = 5#

class IntersliceForceFunctionPoint(x: float, y: float)#: Bases: object

class MethodsProjectSettings(model_id: str, client: Client)#

Bases: object

Examples: Code Snippet: Methods Example

Methods project settings for the model (analysis methods, slices, iterations, etc.).

getNumSlices() → int#: Get the number of slices (2-1000).

setNumSlices(num_slices: int)#: Set the number of slices (2-1000).

getMaxIterations() → int#: Get the maximum number of iterations (10-10000).

setMaxIterations(max_iterations: int)#: Set the maximum number of iterations (10-10000).

getTolerance() → float#: Get the convergence tolerance.

setTolerance(tolerance: float)#: Set the convergence tolerance.

getUseBishop() → bool#: Get whether Bishop method is enabled.

setUseBishop(use: bool)#

getUseCorpsOfEngineers1() → bool#: Get whether Corps of Engineers 1 method is enabled.

setUseCorpsOfEngineers1(use: bool)#

getUseCorpsOfEngineers2() → bool#: Get whether Corps of Engineers 2 method is enabled.

setUseCorpsOfEngineers2(use: bool)#

getUseGle() → bool#: Get whether GLE method is enabled.

setUseGle(use: bool)#

getUseJanbuSimplified() → bool#: Get whether Janbu Simplified method is enabled.

setUseJanbuSimplified(use: bool)#

getUseJanbuCorrected() → bool#: Get whether Janbu Corrected method is enabled.

setUseJanbuCorrected(use: bool)#

getUseLoweKarafiath() → bool#: Get whether Lowe-Karafiath method is enabled.

setUseLoweKarafiath(use: bool)#

getUseOrdinaryFellenius() → bool#: Get whether Ordinary/Fellenius method is enabled.

setUseOrdinaryFellenius(use: bool)#

getUseSpencer() → bool#: Get whether Spencer method is enabled.

setUseSpencer(use: bool)#

getUseSarma() → bool#: Get whether Sarma method is enabled.

setUseSarma(use: bool)#

getIntersliceForceFunctionType() → IntersliceForceFunctionType#: Get the interslice force function type. Use SL_CONSTANT, SL_TRAPEZOID, SL_HALFSINE, SL_CLIPPEDSINE, or SL_GENERAL.

setIntersliceForceFunctionType(function_type: IntersliceForceFunctionType)#

getIntersliceForceFunctionPoints() → List[IntersliceForceFunctionPoint]#: Get the interslice force function points (for TRAPEZOID, CLIPPED_SINE, or GENERAL types).

setIntersliceForceFunctionPoints(points: List[IntersliceForceFunctionPoint])#

getCohesionSarma() → float#: Get the Sarma interslice cohesion (used when interslice strength is user-defined).

setCohesionSarma(cohesion: float)#: Set the Sarma interslice cohesion.

getPhiSarma() → float#: Get the Sarma interslice phi in degrees (used when interslice strength is user-defined).

setPhiSarma(phi: float)#: Set the Sarma interslice phi in degrees.

getSarmaAddSlicesAtMaterialIntersections() → bool#: Get whether Sarma uses material boundaries for slice surfaces.

setSarmaAddSlicesAtMaterialIntersections(intersect: bool)#: Set whether Sarma uses material boundaries for slice surfaces.

getSlicesType() → SlicesType#: Get the slice type: SL_SLICES_VERTICAL (0) or SL_SLICES_SARMA (1).

setSlicesType(slices_type: SlicesType)#: Set the slice type. Use SL_SLICES_VERTICAL or SL_SLICES_SARMA.

getSarmaIntersliceOption() → SarmaIntersliceOption#: Get Sarma interslice strength option: COMPUTED or USER_DEFINED.

setSarmaIntersliceOption(option: SarmaIntersliceOption)#: Set Sarma interslice strength option. Use SL_SARMA_INTERSLICE_COMPUTED or SL_SARMA_INTERSLICE_USER_DEFINED.

getSarmaSliceAngleOption() → SarmaSliceAngleOption#: Get Sarma slice angle option: SL_SARMA_SLICE_ANGLE_OPTIMIZED or SL_SARMA_SLICE_ANGLE_USER_DEFINED.

setSarmaSliceAngleOption(option: SarmaSliceAngleOption)#: Set Sarma slice angle option. Use SL_SARMA_SLICE_ANGLE_OPTIMIZED or SL_SARMA_SLICE_ANGLE_USER_DEFINED.

getOptimizedSarmaSliceAnglesMethod() → OptimizedSarmaSliceAnglesMethod#: Get Sarma slice angles method when slice angle is optimized (SL_SLICE_ANGLE_METHOD_*).

setOptimizedSarmaSliceAnglesMethod(method: OptimizedSarmaSliceAnglesMethod)#: Set Sarma slice angles method when optimized. Use SL_SLICE_ANGLE_METHOD_* constants.

getUserDefinedSarmaSliceAnglesMethod() → UserDefinedSarmaSliceAnglesMethod#: Get Sarma slice angles method when slice angle is user-defined (SL_SLICE_ANGLE_METHOD_*).

setUserDefinedSarmaSliceAnglesMethod(method: UserDefinedSarmaSliceAnglesMethod)#: Set Sarma slice angles method when user-defined. Use SL_SLICE_ANGLE_METHOD_* constants.