Slide2Model#

class Slide2Model(client: Client, model_id: str, file_name: str)#

Bases: object

getUserDefinedFunctions() → UserDefinedFunctions#

Access user-defined strength functions (Shear/Normal, C/Phi, Discrete, Undrained/Vertical) for this model.

getUserDefinedHydraulicModels() → UserDefinedHydraulicModels#

Access project-level user-defined hydraulic (water) methods used when a material’s water mode is User defined.

getTensionCrackProperties() → TensionCrackProperties#

Access tension crack properties for this model.

getSeismicLoadSettings() → SeismicLoadSettings#

Access seismic load settings for this model.

getSlopeLimitSettings() → SlopeLimitsSettings#

Access slope limits for this model.

getCPTData() → CPTData#

Access CPT borehole / sounding data.

getProjectSettings() → ProjectSettings#

Access general project settings for this model.

getSurfaceOptions() → SurfaceOptions#

Access surface options (surface type, filters, and per-search-method options) for this model.

getModelerDisplayOptions() → ModelerDisplayOptions#

Access modeler display options (colors, visibility, drawing, ruler, etc.) for this model.

getProbabilisticStatistics() → ProbabilisticStatistics#

Access probabilistic variable definitions via Material, Support, Load, WaterTable, and other sub-objects (see ProbabilisticStatistics).

getBackAnalysisTensionMap() → BackAnalysisTensionMap#

Access back analysis of support and support tension map project settings for this model.

getSupportDesigner() → SupportDesigner#

Access Support Designer compute and apply-results APIs for this model.

getMultiDocScenarioModel() → MultiDocScenarioModel#

Access multi-scenario (.slmd) model groups and scenarios (list, add, remove, rename, duplicate).

getMaterialProperties() → list[MaterialProperty]#

Examples: Code Snippet: Model Manipulation

addMaterialProperty() → MaterialProperty#

Adds a new material property to the model.

Returns:

The newly created material property.

Return type:

MaterialProperty

Examples

Code Snippet: Model Manipulation

deleteMaterialProperty(material_index: int)#

Deletes a material property from the model.

Parameters:

material_index – The index of the material property to delete.

Examples

Code Snippet: Model Manipulation

getSupportProperties() → list[SupportProperty]#

Examples: Code Snippet: Model Manipulation

addSupportProperty() → SupportProperty#

Adds a new support property to the model.

Returns:

The newly created support property.

Return type:

SupportProperty

Examples

Code Snippet: Model Manipulation

deleteSupportProperty(support_index: int)#

Deletes a support property from the model.

Parameters:

support_index – The index of the support property to delete.

Examples

Code Snippet: Model Manipulation

compute() → ComputeResponse#

Examples: Code Snippet: Model Manipulation

save(fileName: str = None)#

Examples: Code Snippet: Model Manipulation

close(saveChanges=True)#

Examples: Code Snippet: Model Manipulation