D-Stability¶

D-Stability model¶

class geolib.models.dstability.dstability_model.DStabilityCalculationModel(value)¶

Set Type of Calculation.

Bishop = 1¶

Spencer = 3¶

UpliftVan = 2¶

class geolib.models.dstability.dstability_model.DStabilityCalculationType(value)¶

Set Type of Calculation.

BoundarySearch = 1¶

SingleCalc = 2¶

class geolib.models.dstability.dstability_model.DStabilityModel(*args, **data)¶

D-Stability is software for soft soil slope stability.

This model can read, modify and create .stix files

add_head_line(points, label='', notes='', is_phreatic_line=False, stage_id=None)¶

Add head line to the model

Parameters

points (List[Point]) – list of Point classes
label (str) – label defaults to empty string
notes (str) – notes defaults to empty string
is_phreatic_line (bool) – set as phreatic line, defaults to False
stage_id (int) – stage to add to, defaults to current stage

Returns

id of the added headline

Return type

bool

add_layer(points, soil_code, label='', notes='', stage_id=None)¶

Add a soil layer to the model

Parameters

points (List[Point]) – list of Point classes, in clockwise order (non closed simple polygon)
soil_code (str) – code of the soil for this layer
label (str) – label defaults to empty string
notes (str) – notes defaults to empty string
stage_id (int) – stage to add to, defaults to 0

Returns

id of the added layer

Return type

int

add_load(load, consolidations=None, stage_id=None)¶

Add a load to the object.

The geometry should be defined before adding loads.

If no consolidations are provided, a Consolidation with default values will be made for each SoilLayer. It is not possible to set consolidation degrees of loads afterwards since they don’t have an id.

Parameters

load (DStabilityLoad) – A subclass of DStabilityLoad.
stage_id (Optional[int]) – Id used to identify the stage to which the load is linked. If no stage_id is proved, the current stage_id will be taken.
consolidations (Optional[List[Consolidation]]) –

Raises

ValueError – When the provided load is no subclass of DStabilityLoad, an invalid stage_id is provided, or the datastructure is no longer valid.

Return type

None

add_point(point, stage=None)¶

Add point, which should be unique in the model and return the created point id.

Parameters: point (Point) –
Return type: int

add_reference_line(points, bottom_headline_id, top_head_line_id, label='', notes='', stage_id=None)¶

Add reference line to the model

Parameters

points (List[Point]) – list of Point classes
bottom_headline_id (int) – id of the headline to use as the bottom headline
top_head_line_id (int) – id of the headline to use as the top headline
label (str) – label defaults to empty string
notes (str) – notes defaults to empty string
stage_id (int) – stage to add to, defaults to 0

Returns

id of the added reference line

Return type

int

add_reinforcement(reinforcement, stage_id=None)¶

Add a reinforcement to the model.

Parameters

reinforcement (DStabilityReinforcement) – A subclass of DStabilityReinforcement.
stage_id (Optional[int]) – Id used to identify the stage to which the reinforcement is linked.

Returns

Assigned id of the reinforcements (collection object of all reinforcements for a stage).

Return type

int

Raises

ValueError – When the provided reinforcement is no subclass of DStabilityReinforcement, an invalid stage_id is provided, or the datastructure is no longer valid.

add_soil(soil)¶

Add a new soil to the model. The code must be unique, the id will be generated

Parameters: soil (Soil) – a new soil
Returns: id of the added soil
Return type: int

add_soil_layer_consolidations(soil_layer_id, consolidations=None, stage_id=None)¶

Add consolidations for a layer (layerload).

Consolidations cannot be added when adding soil layers since in the consolidations, all other soil layers need to be referred. Therefore, all soillayers in a stage should be defined before setting consolidation and the number of consolidations given should equal the amount of layers.

Parameters

soil_layer_id (int) – Consolidation is set for this soil layer id.
consolidations (Optional[List[Consolidation]]) – List of Consolidation. Must contain a Consolidation for every other layer.
stage_id (Optional[int]) – Id used to identify the stage to which the load is linked. If no stage_id is proved, the current stage_id will be taken.

Raises

ValueError – When the provided load is no subclass of DStabilityLoad, an invalid stage_id is provided, or the datastructure is no longer valid.

Return type

None

add_stage(label, notes, set_current=True)¶

Add a new stage to the model.

Parameters

label (str) – Label for the stage
notes (str) – Notes for the stage
set_current – Whether to make the new stage the current stage.

Return type

int

Returns

the id of the new stage

add_state_line(points, state_points, stage_id=None)¶

Add state line. From the Soils, only the state parameters are used.

points are a list of points with x,z state_point are a list of DStabilit.. where ONLY the x is used, the Z will be calculated

No result PersistableStateLine has no Id

Parameters

points (List[Point]) –
state_points (List[DStabilityStateLinePoint]) –
stage_id (Optional[int]) –

Return type

None

add_state_point(state_point, stage_id=None)¶

Add state point to the model

Parameters

state_point (DStabilityStatePoint) – DStabilityStatePoint class
stage_id (int) – stage_id (int): stage to add to, defaults to the current stage

Returns

id of the added add_state_point

Return type

int

Todo

Check if point lies within the given layer

property console_path: pathlib.Path¶

Return type: Path

copy_stage(label, notes, set_current=True)¶

Copy an existing stage and add it to the model.

Parameters

label (str) – Label for the stage
notes (str) – Notes for the stage
set_current – Whether to make the new stage the current stage.

Return type

int

Returns

the id of the new stage

current_id: int¶

current_stage: int¶

datastructure: geolib.models.dstability.internal.DStabilityStructure¶

edit_soil(code, **kwargs)¶

Edit an existing soil with parameter names based on the soil class members

Parameters

code (str) – the code of the soil
kwargs (dict) – the parameters and new values for example ‘cohesion=2.0, friction_angle=25.0’

Returns

the edited soil

Return type

PersistableSoil

edit_soil_by_name(name, **kwargs)¶

Edit an existing soil with parameter names based on the soil class members. This method will edit the first occurence of the name if the name is used multiple times.

Parameters

name (str) – the name of the soil
kwargs (dict) – the parameters and new values for example ‘cohesion=2.0, friction_angle=25.0’

Returns

the edited soil

Return type

PersistableSoil

get_result(stage_id)¶

Returns the results of a stage. Calculation results are based on analysis type and calculation type.

Parameters: stage_id (int) – Id of a stage.
Returns: Dictionary containing the analysis results of the stage.
Return type: dict
Raises: ValueError – No results or calculationsettings available

get_slipcircle_result(stage_id)¶

Get the slipcircle(s) of the calculation result of a given stage.

Parameters

stage_id (int) – stage for which to get the available results

Returns

dictionary of the available slipcircles per model for the given stage

Return type

Dict

Raises

ValueError – Result is not available for provided stage id
AttributeError – When the result has no slipcircle. Try get the slipplane

get_slipplane_result(stage_id=0)¶

Get the slipplanes of the calculations result of a stage.

Parameters

stage_id (int) – stage for which to get the available results

Returns

dictionary of the available slip planes per model for the given stage

Return type

dict

Raises

ValueError – Result is not available for provided stage id
AttributeError – When the result has no slipplane. Try get the slipcircle

Access internal dict-like datastructure of the output.

Requires a successful execute.

Return type: Union[UpliftVanResult, UpliftVanParticleSwarmResult, UpliftVanReliabilityResult, SpencerGeneticAlgorithmResult, SpencerReliabilityResult, SpencerResult, BishopBruteForceResult, BishopReliabilityResult, BishopResult]

parse(*args, **kwargs)¶: Parse input or outputfile to Model, depending on extension.

property parser_provider_type: Type[geolib.models.dstability.dstability_parserprovider.DStabilityParserProvider]¶

Returns the parser provider type of the current concrete class.

Raises: NotImplementedError – If not implemented in the concrete class.
Return type: Type[DStabilityParserProvider]
Returns: Type[BaseParserProvider] – Concrete parser provider.

property points¶: Enables easy access to the points in the internal dict-like datastructure. Also enables edit/delete for individual points.

serialize(location)¶

Support serializing to directory while developing for debugging purposes.

Parameters: location (Union[FilePath, DirectoryPath, BinaryIO]) –

set_model(analysis_method, stage_id=None)¶

Sets the model and applies the given parameters

Parameters

analysis_method (DStabilityAnalysisMethod) – A subclass of DStabilityAnalysisMethod.
stage_id – Id used to identify the stage to which the analysis method is linked.

Raises

ValueError – When the provided analysismethod is no subclass of DStabilityAnalysisMethod,
an invalid stage_id is provided, the analysis method is not known or the datastructure is no longer valid. –

property soils: geolib.models.dstability.internal.SoilCollection¶

Enables easy access to the soil in the internal dict-like datastructure. Also enables edit/delete for individual soils.

Return type: SoilCollection

property stages: List[geolib.models.dstability.internal.Stage]¶

Return type: List[Stage]

property waternets: List[geolib.models.dstability.internal.Waternet]¶

Return type: List[Waternet]

class geolib.models.dstability.dstability_model.DStabilityObject(**data)¶

Parameters: data (Any) –

class geolib.models.dstability.analysis.DStabilityAnalysisMethod(**data)¶

Parameters: data (Any) –

property analysis_type: geolib.models.dstability.internal.AnalysisTypeEnum¶

Return type: AnalysisTypeEnum

class geolib.models.dstability.analysis.DStabilityBishopAnalysisMethod(**data)¶

Generates slip plane constraints object for the Bishop method

Parameters

circle (DStabilityCircle) – Bishop circle definition
data (Any) –

circle: geolib.models.dstability.analysis.DStabilityCircle¶

class geolib.models.dstability.analysis.DStabilityBishopBruteForceAnalysisMethod(**data)¶

Generates slip plane constraints object for the Bishop Brute Force method

Parameters

extrapolate_search_space (bool) – Extrapolate the search space, defaults to True
search_grid (DStabilitySearchGrid) –
slip_plane_constraints (DStabilitySlipPlaneConstraints) –
bottom_tangent_line_z (float) –
number_of_tangent_lines (int) –
space_tangent_lines (float) –
data (Any) –

bottom_tangent_line_z: float¶

extrapolate_search_space: bool¶

number_of_tangent_lines: pydantic.types.PositiveInt¶

search_grid: geolib.models.dstability.analysis.DStabilitySearchGrid¶

slip_plane_constraints: geolib.models.dstability.analysis.DStabilitySlipPlaneConstraints¶

space_tangent_lines: geolib.models.dstability.analysis.ConstrainedFloatValue¶

class geolib.models.dstability.analysis.DStabilityCircle(**data)¶

Generates a circle object

Parameters

center (Point) – Center of the circle.
radius (float) – Radius of the circle.
data (Any) –

center: geolib.geometry.one.Point¶

radius: geolib.models.dstability.analysis.ConstrainedFloatValue¶

class geolib.models.dstability.analysis.DStabilityGeneticSlipPlaneConstraints(**data)¶

Generates slip plane constraints object for the Spencer method

Parameters

is_enabled (bool) – Height of the search area.
minimum_angle_between_slices (float) – Minimum angle between slices, defaults to 0.
minimum_thrust_line_percentage_inside_slices (float) – Minimum thrustline percentage inside slices, defaults to 0.
data (Any) –

is_enabled: bool¶

minimum_angle_between_slices: float¶

minimum_thrust_line_percentage_inside_slices: float¶

class geolib.models.dstability.analysis.DStabilityObject(**data)¶

Base Class for objects in the analysis module.

Parameters: data (Any) –

class geolib.models.dstability.analysis.DStabilitySearchArea(**data)¶

Generates a search area object

Parameters

height (float) – Height of the search area.
top_left (Point) – Top left position of the search area
width (float) – Width of the search area
data (Any) –

height: geolib.models.dstability.analysis.ConstrainedFloatValue¶

top_left: geolib.geometry.one.Point¶

width: geolib.models.dstability.analysis.ConstrainedFloatValue¶

class geolib.models.dstability.analysis.DStabilitySearchGrid(**data)¶

Generates a search grid object

Parameters

bottom_left (Point) – Bottom left position of the search grid.
number_of_points_in_x (int) – Number of points to the right
number_of_points_in_z (int) – Number op points upwards
space (float) – Space between the points in x and z direction
data (Any) –

bottom_left: geolib.geometry.one.Point¶

number_of_points_in_x: pydantic.types.PositiveInt¶

number_of_points_in_z: pydantic.types.PositiveInt¶

space: geolib.models.dstability.analysis.ConstrainedFloatValue¶

class geolib.models.dstability.analysis.DStabilitySlipPlaneConstraints(**data)¶

Generates a slip plane constraints object

Parameters

is_size_constraints_enabled (bool) – enabel size constraints, defaults to False
is_zone_a_constraints_enabled (bool) – enable constraints for zone A, defaults to False
is_zone_b_constraints_enabled (bool) – enable constraints for zone B, defaults to False
minimum_slip_plane_depth (float) – minimum slip plane depth, defaults to 0.0
minimum_slip_plane_length (float) – minimum slip plane length, defaults to 0.0
width_zone_a (float) – width of zone A, defaults to 0.0
width_zone_b (float) – width of zone B, defaults to 0.0
x_left_zone_a (float) – x coordinate of left point of zone A, defaults to 0.0
x_left_zone_b (float) – x coordinate of left point of zone B, defaults to 0.0
data (Any) –

is_size_constraints_enabled: bool¶

is_zone_a_constraints_enabled: bool¶

is_zone_b_constraints_enabled: bool¶

minimum_slip_plane_depth: float¶

minimum_slip_plane_length: float¶

width_zone_a: float¶

width_zone_b: float¶

x_left_zone_a: float¶

x_left_zone_b: float¶

class geolib.models.dstability.analysis.DStabilitySpencerAnalysisMethod(**data)¶

Generates slip plane for the Spencer method

Parameters

slipplane ([Point]) – The points of the slipplane
data (Any) –

slipplane: List[geolib.geometry.one.Point]¶

class geolib.models.dstability.analysis.DStabilitySpencerGeneticAnalysisMethod(**data)¶

Generates the input for the genetic spencer algorithm

Parameters

options_type (OptionsType) – DEFAULT or THOROUGH, defaults to DEFAULT
slip_plane_a (List[Point]) – upper slip plane boundary
slip_plane_b (List[Point]) – lower slip line boundary
slip_plane_constraints (DStabilityGeneticSlipPlaneConstraints) – constraints for the slip plane
data (Any) –

options_type: geolib.models.dstability.internal.OptionsTypeEnum¶

slip_plane_a: List[geolib.geometry.one.Point]¶

slip_plane_b: List[geolib.geometry.one.Point]¶

slip_plane_constraints: geolib.models.dstability.analysis.DStabilityGeneticSlipPlaneConstraints¶

class geolib.models.dstability.analysis.DStabilityUpliftVanAnalysisMethod(**data)¶

Generates the input for the uplift van analysis

Parameters

first_circle (DStabilityCircle) – The location of the left circle for the slipplane.
second_circle_center (Point) – The center of the circle on the right side of the slipplane
data (Any) –

first_circle: geolib.models.dstability.analysis.DStabilityCircle¶

second_circle_center: geolib.geometry.one.Point¶

class geolib.models.dstability.analysis.DStabilityUpliftVanParticleSwarmAnalysisMethod(**data)¶

Generates the input for the uplift van analysis

Parameters

options_type (OptionsType) – DEFAULT or THOROUGH, defaults to DEFAULT
search_area_a (DStabilitySearchArea) – The search area for the circle on the left side of the slip plane
search_area_b (DStabilitySearchArea) – The search area for the circle on the right side of the slip plane
slip_plane_constraints (DStabilitySlipPlaneConstraints) – Slip plane constraints
tangent_area_height (float) – height of the tangent lines search area
tangent_area_top_z (float) – top z coordinate of the tangent lines area
data (Any) –

options_type: geolib.models.dstability.internal.OptionsTypeEnum¶

search_area_a: geolib.models.dstability.analysis.DStabilitySearchArea¶

search_area_b: geolib.models.dstability.analysis.DStabilitySearchArea¶

slip_plane_constraints: geolib.models.dstability.analysis.DStabilitySlipPlaneConstraints¶

tangent_area_height: float¶

tangent_area_top_z: float¶

Loads¶

This module handles the four types of loads in DStability.

class geolib.models.dstability.loads.Consolidation(**data)¶

Parameters: data (Any) –

degree: geolib.models.dstability.loads.ConstrainedFloatValue¶

layer_id: int¶

to_internal_datastructure()¶

Return type: PersistableConsolidation

class geolib.models.dstability.loads.DStabilityLoad(**data)¶

Base Class for Loads.

Parameters: data (Any) –

label: Optional[str]¶

abstract to_internal_datastructure()¶

class geolib.models.dstability.loads.Earthquake(**data)¶

Inherits DStabilityLoad.

Parameters: data (Any) –

free_water_factor: float¶

horizontal_factor: float¶

vertical_factor: float¶

class geolib.models.dstability.loads.LineLoad(**data)¶

DStability Lineload.

Parameters: data (Any) –

angle: geolib.models.dstability.loads.ConstrainedFloatValue¶

angle_of_distribution: geolib.models.dstability.loads.ConstrainedFloatValue¶

location: geolib.geometry.one.Point¶

magnitude: geolib.models.dstability.loads.ConstrainedFloatValue¶

to_internal_datastructure()¶

Return type: PersistableLineLoad

class geolib.models.dstability.loads.TreeLoad(**data)¶

Inherits DStabilityLoad.

Parameters: data (Any) –

angle_of_distribution: float¶

height: float¶

width_of_root_zone: float¶

wind_force: float¶

class geolib.models.dstability.loads.UniformLoad(**data)¶

UniformLoad.

Parameters: data (Any) –

angle_of_distribution: geolib.models.dstability.loads.ConstrainedFloatValue¶

end: float¶

classmethod end_greater_than_start(v, values)¶

magnitude: geolib.models.dstability.loads.ConstrainedFloatValue¶

start: float¶

to_internal_datastructure()¶

Return type: PersistableUniformLoad

Reinforcements¶

This module handles the three types of reinforcements in DStability.

class geolib.models.dstability.reinforcements.DStabilityReinforcement(**data)¶

Base Class for Reinforcements.

Parameters: data (Any) –

label: Optional[str]¶

class geolib.models.dstability.reinforcements.ForbiddenLine(**data)¶

Inherits DStabilityReinforcement. Needs to be further defined.

Parameters: data (Any) –

end: geolib.geometry.one.Point¶

start: geolib.geometry.one.Point¶

class geolib.models.dstability.reinforcements.Geotextile(**data)¶

Parameters: data (Any) –

effective_tensile_strength: geolib.models.dstability.reinforcements.ConstrainedFloatValue¶

end: geolib.geometry.one.Point¶

reduction_area: geolib.models.dstability.reinforcements.ConstrainedFloatValue¶

start: geolib.geometry.one.Point¶

class geolib.models.dstability.reinforcements.Nail(**data)¶

DStability Nail, used for soil nailing.

Parameters: data (Any) –

bending_stiffness: geolib.models.dstability.reinforcements.ConstrainedFloatValue¶

critical_angle: float¶

diameter: geolib.models.dstability.reinforcements.ConstrainedFloatValue¶

direction: float¶

grout_diameter: geolib.models.dstability.reinforcements.ConstrainedFloatValue¶

horizontal_spacing: float¶

lateral_stresses: List[Tuple[float, float]]¶

length: geolib.models.dstability.reinforcements.ConstrainedFloatValue¶

location: geolib.geometry.one.Point¶

max_pull_force: float¶

plastic_moment: float¶

shear_stresses: List[Tuple[float, float]]¶

use_facing: bool¶

use_lateral_stress: bool¶

use_shear_stress: bool¶

States¶

This module handles the three types of state types in DStability.

class geolib.models.dstability.states.DStabilityObject(**data)¶

Parameters: data (Any) –

class geolib.models.dstability.states.DStabilityStateLinePoint(**data)¶

Parameters: data (Any) –

above: geolib.models.dstability.states.DStabilityStress¶

below: geolib.models.dstability.states.DStabilityStress¶

id: int¶

is_above_and_below_correlated: bool¶

is_probabilistic: bool¶

label: str¶

x: float¶

class geolib.models.dstability.states.DStabilityStatePoint(**data)¶

DStability StatePoint

Parameters

id (int) – id of the statepoint
layer_id (int) – id of the layer to add the statepoint, note that the API does not check if this point is within the layer
pop (float) – POP value, defaults to 0.0
point (Point) – location of the statepoint
stress (DStabilityStress) – DStabilityStress object
is_probabilistic (bool) – is probabilistic, default to false
label (str) – label of the statepoint
data (Any) –

id: int¶

is_probabilistic: bool¶

label: str¶

layer_id: int¶

point: geolib.geometry.one.Point¶

stress: geolib.models.dstability.states.DStabilityStress¶

class geolib.models.dstability.states.DStabilityStress(**data)¶

DStability Stress

Parameters

ocr (float) – OCR value, defaults to 1.0
pop (float) – POP value, defaults to 0.0
stochastic_parameter (PersistableStochasticParameter) –
state_type (StateType) – type of state
data (Any) –

ocr: float¶

pop: float¶

state_type: geolib.models.dstability.internal.StateType¶

stochastic_parameter: geolib.models.dstability.internal.PersistableStochasticParameter¶

Geometry¶

Add layer¶

For the geometry it is import to set the geometry points in the correct order. I.e. per polygon, set the points in clockwise or anticlockwise order. Furthermore it is import to add all points which are part or touch a certain polygon. This procedure is automatically done when the user creates a geometry via the user interface. However when the user wants to create a geometry via Geolib, it is important to specify all points for each layer. An example is illustrated below.

The following valid code will produce a correct geometry, note that the clay layer is a rectangular layer, but still requires 6 geometry points. This is because the dike layer touches the clay layer at two points. If the clay layer is only generated the 4 corner points, a valid geometry is generated, however unexpected results can occur.

import geolib
from geolib.geometry import Point
from pathlib import Path

ds = geolib.DStabilityModel()

clay_points = [Point(x=-50, z=-10),
               Point(x=-50, z=-5),
               Point(x=0, z=-5),
               Point(x=20, z=-5),
               Point(x=50, z=-5),
               Point(x=50, z=-10)]

dike_points = [Point(x=5, z=2),
               Point(x=15, z=2),
               Point(x=20, z=-5),
               Point(x=0, z=-5)]

soil_clay= geolib.soils.Soil()
soil_dike = geolib.soils.Soil()
soil_clay.code = 'clay'
soil_dike.code = 'dike'

ds.add_soil(soil_clay)
ds.add_soil(soil_dike)

ds.add_layer(clay_points, soil_clay.code)
ds.add_layer(dike_points, soil_dike.code)

ds.filename = Path('geometry_example.stix')
ds.serialize(ds.filename)