geolib.models.dsheetpiling.dsheetpiling_model

Classes

BaseModelType(**data)	Base Class for Model types (Pile, Sheet, Wall).
DSheetPilingModel(**data)	DSheetPiling is a tool used to design sheetpile and diaphragm walls and horizontally loaded piles.
DiaphragmModelType(**data)
SheetModelType(**data)
SinglePileModelType(**data)
WoodenSheetPileModelType(**data)

class geolib.models.dsheetpiling.dsheetpiling_model.BaseModelType(**data)

Base Class for Model types (Pile, Sheet, Wall).

Parameters:

data (Any)

abstract property model

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class geolib.models.dsheetpiling.dsheetpiling_model.DSheetPilingModel(**data)

DSheetPiling is a tool used to design sheetpile and diaphragm walls and horizontally loaded piles.

This model can read, modify and create *.shi files, read *.shd and *.err files.

Parameters:

data (Any)

add_anchor_or_strut(support, stage_id, pre_stress=0)

Add anchor or strut to a stage.

Anchor and Strut supports are only available for the sheetpiling model.

Parameters:

• support (Union[Anchor, Strut]) – Anchor and Strut.

• pre_stress (float) – Prestress for the support which is added to a construction stage. This is a tension stress for the anchor and a compression stress for the strut.

• stage_id (int) – Support is added to this stage.

Return type:

None

add_calculation_options_per_stage(calculation_options_per_stage, stage_id)

Set calculation options per stage.

Calculation options per stage are set in [CALCULATION OPTIONS PER STAGE].

Parameters:

• calculation_options_per_stage (CalculationOptionsPerStage) – Calculation options for stage

• stage_id (int) – Settings are set to this stage. This refers to the Pythonic input and has a starting point of 0.

Raises:

ValueError – When non-existing stage_id is passed or when no CalculationOptionsPerStage are required.

Return type:

None

add_head_line(water_level, side, stage_id)

Set water level for a stage.

If a water level already exists, it is refered to that water level.

Related to the [WATERLEVELS] block in the .shi file.

Parameters:

• water_level (WaterLevel) – WaterLevel.

• side (Side) – Side which determines on which side the surface is added.

• stage_id (int) – WaterLevel is added to this stage.

Raises:

ValueError – When non-existing stage_id is passed.

Return type:

None

add_load(load, stage_id)

Adds other loads of type Moment, HorizontalLineLoad, NormalForce, SoilDisplacement or UniformLoad

Parameters:

• load (Union[Moment, HorizontalLineLoad, NormalForce, SoilDisplacement, UniformLoad]) – Add a load with the types of Moment, HorizontalLineLoad, NormalForce, SoilDisplacement or UniformLoad.

• stage_id (int) – Load is added to this stage.

Note: SoilDisplacement and UniformLoad are only valid for a sheetpiling construction.

Raises:

• ValueError – When non-existing stage_id is passed.

• ValueError – When a verification calculation is selected but duration_type and load_type are not defined for the load.

add_profile(profile, side, stage_id)

Add a Profile on the left or right side of a stage.

Profile is added to [SOIL PROFILES] if not yet added; reference is done by name. A reference in [CONSTRUCTION STAGES] is updated.

Parameters:

• profile (SoilProfile) – Profile.

• side (Side) – Side which determines on which side the profile is added.

• stage_id (int) – Surface is added to this stage.

Raises:

ValueError – When non-existing stage_id is passed.

Return type:

None

add_soil(soil)

Soil is converted in the internal structure and added in soil_collection.

Parameters:

soil (Soil)

Return type:

str

add_stage(name, passive_side, method_left, method_right, pile_top_displacement=0.0)

Add a new stage to the model.

When using a Single Pile model, the lateral earth pressure method left and right need to be the same. Their inputs however do not effect the outcome of the calculation.

Parameters:

• name (str) – Name of the stage.

• passive_side (PassiveSide) – Option to set the passive side for the stage.

• method_left (LateralEarthPressureMethodStage) – LateralEarthPressureMethodStage applied to left side, must be compatible with the Model LateralEarthPressureMethod

• method_right (LateralEarthPressureMethodStage) – LateralEarthPressureMethodStage applied to right side, must be compatible with the Model LateralEarthPressureMethod

• pile_top_displacement (float) – Pile top displacement [m]. When not provided, Use top displacement will be set to false.

Raises:

ValidationError – when input arguments are not within constraints

Returns:

Stage id which can be used to modify the stage.

Return type:

int

add_support(support, stage_id)

Add spring or rigid support to a stage.

Parameters:

• support (Union[SpringSupport, RigidSupport]) – SpringSupport or RigidSupport.

• stage_id (int) – ID of the stage. Of no ID is provided, the current stage ID will be taken.

Return type:

None

add_surcharge_load(load, side, stage_id)

Add surcharge load to a stage.

Parameters:

• load (SurchargeLoad) – SurchargeLoad.

• side (Side) – Side which determines on which side the load is added.

• stage_id (int) – SurchareLoad is added to this stage.

Raises:

ValueError – When non-existing stage_id is passed.

Return type:

None

add_surface(surface, side, stage_id)

Set surface for a stage.

Surface is added to [SURFACES] if not yet added; reference is done by name. A reference in [CONSTRUCTION STAGES] is updated.

Parameters:

• surface (Surface) – Surface.

• side (Side) – Side which determines on which side the surface is added.

• stage_id (int) – Surface is added to this stage.

Raises:

ValueError – When non-existing stage_id is passed.

Return type:

None

property console_flags: List[str]

current_stage: Optional[int]

property custom_console_path: Path

datastructure: Union[DSheetPilingStructure, DSheetPilingDumpStructure]

This is the base class for all models in GEOLib.

Note that datastructure is a SerializeAsAny type, which means that the inheriting class is serialized according to its own definition (duck-typing). This is needed since Pydantic v2 as the default behavior has changed: https://docs.pydantic.dev/latest/concepts/serialization/#subclass-instances-for-fields-of-basemodel-dataclasses-typeddict

property default_console_path: Path

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'current_stage': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'datastructure': FieldInfo(annotation=Union[DSheetPilingStructure, DSheetPilingDumpStructure], required=False, default=DSheetPilingStructure(input_data=DSheetPilingInputStructure(version=Version(soil=1010, d__sheet_piling=1033), version_externals=VersionExternals(dgscptipcalc____dll='21.3.1.35380', dgscptipui____dll='21.3.1.35380'), soil_collection=SoilCollection(soil=[]), run_identification='\n\n', model=Model(model=<ModelType.SHEET_PILING: 0>, method=<LateralEarthPressureMethod.MIXED: 2>, verification=False, pile_load_option=False, pile_load_by_user=False, probabilistic=False, check_vertical_balance=True, trildens_calculation=True, diepwand_calculation=False, elastic_calculation=True, wooden_sheetpiling=False), cpt_list='Count=0', sheet_piling=SheetPiling(sheetpiling=[SheetPileElement(name='New element', sheetpilingelementmaterialtype=<SheetPilingElementMaterialType.Steel: 1>, sheetpilingelementei=100000.0, sheetpilingelementwidth=1.0, sheetpilingelementlevel=-10.0, sheetpilingelementheight=400, sheetpilingpilewidth=0.0, sheetpilingelementsectionarea=170, sheetpilingelementresistingmoment=0, sheetpilingelementreductionfactorei=1.0, sheetpilingelementnote='', sheetpilingelementmaxcharacteristicmoment=0.0, sheetpilingelementmaxplasticcharacteristicmoment=0.0, sheetpilingelementkmod=0.01, sheetpilingelementmaterialfactor=0.01, ssheetpilingelementreductionfactormaxmoment=1.0, diaphragmwallissymmetric=0, diaphragmwallposeielastoplastic1=0.0, diaphragmwallnegeielastoplastic1=0.0, diaphragmwallposmomelastic=100000.0, diaphragmwallnegmomelastic=0.0, diaphragmwallposmomplastic=0.0, diaphragmwallnegmomplastic=0.0, diaphragmwallposeielastoplastic2=0.0, diaphragmwallposmomelastoplastic=0.0, diaphragmwallnegeielastoplastic2=0.0, diaphragmwallnegmomelastoplastic=0.0, woodensheetpilingelemente=100000.0, woodensheetpilingelementcharacflexuralstrength=0.0, woodensheetpilingelementksys=1.15, woodensheetpilingelementkdef=1.0, woodensheetpilingelementpsi2eff=1.0, woodensheetpilingelementmaterialfactor=1.3, woodensheetpilingelementkmodfshort=0.65, woodensheetpilingelementkmodflong=0.5, woodensheetpilingelementkmode=0.8)], leveltopsheetpiling=0.0, lengthsheetpiling=10.0), combined_wall='', vertical_balance='SheetPilingQcRep=0.000\nSheetPilingXi=1.39', settlement_by_vibration_params='SheetPilingNumberOfPilesDrilled=2', horizontal_line_loads=None, uniform_loads=None, surcharge_loads=None, water=Water(unit_weight_of_water=9.81), earth_quake='0.00', soil_profiles='  1 Number of spring characteristics curves\n  0 1/0 : Yes/No Unloading curve\n  1 1/0 : Yes/No Use Cur values\n\n  1 Number of soil profiles \nNew Profile\n       0.000 X coordinate\n       0.000 Y coordinate\n\n  1 Number of soil layers per soil profile\n Nr      Level   Wosp Top  Wosp Bott Material Name\n  1       0.00       0.00       0.00 New Material', surfaces='1 Number of surfaces \n1     1 New Surface\n0.00  Standard deviation\n2  Distribution type\nNr     X-coord     Value\n1       0.00       0.00', waterlevels='  1 Number of Waterlevels \n  3 Number of Data per Waterlevel \nNew Water Level\n      0.00\n      0.00\n         2', construction_stages=ConstructionStages(stages=[]), calculation_options_per_stage=CalculationOptionsPerStage(stageoptions=[]), calculation_options=CalculationOptions(calcfirststageinitial=False, calcminornodeson=False, calcreducedeltas=False, inputcalculationtype=<CalculationType.STANDARD: 0>, isvibrationcalculation=False, allowableanchorforcecalculationtype=False, calcautolambdason=True, designstage=0, designpilelengthfrom=1.0, designpilelengthto=1.0, designpilelengthdecrement=0.01, designpilelengthnew=1, designtype=<DesignType.REPRESENTATIVE: 0>, designeurocodepartialfactorset=<PartialFactorSetEC.DA1SET1: 0>, designpartialfactorsetec7nadnl=<PartialFactorSetEC7NADNL.RC0: 0>, designec7nlmethod=<PartialFactorCalculationType.METHODA: 0>, designec7bmethod=<PartialFactorCalculationType.METHODA: 0>, designec7bepartialfactorset=<PartialFactorSetEC7NADBE.RC1SET1: 0>, designec7bemethod=<PartialFactorCalculationType.METHODA: 0>, designpartialfactorset=<PartialFactorSetCUR.CLASSI: 0>, designcurmethod=<PartialFactorCalculationType.METHODA: 0>, verifytype=<VerifyType.CUR: 0>, eurocodepartialfactorset=<PartialFactorSetVerifyEC.DA1: 0>, eurocodeoverallstability=False, ec7nlmethod=<PartialFactorCalculationType.METHODA: 0>, ec7nloverallpartialfactorset=<PartialFactorSetEC7NADNL.RC0: 0>, ec7nloverallanchorfactor=1.0, ec7nadnloverallstability=False, ec7nlassessmenttype=<AssessmentTypeEC7NL.NewConstruction: 0>, ec7beoverallstability=False, ec7bemethod=<PartialFactorCalculationType.METHODA: 0>, ec7beoverallriskclass=<RiskClassEC7BE.RC2: 1>, nbmethod=<PartialFactorCalculationType.METHODA: 0>, curmethod=<PartialFactorCalculationType.METHODA: 0>, curoverallpartialfactorset=<PartialFactorSetCUR.CLASSI: 0>, curoverallanchorfactor=1.0, curoverallstability=False, curanchorforcestage=0, curstabilitystage=0, overallstabilitytype=<DesignType.REPRESENTATIVE: 0>, stabilityexport=False, stabilityeurocodepartialfactorset=<PartialFactorSetEC.DA1SET1: 0>, stabilityec7nlpartialfactorset=<PartialFactorSetEC7NADNL.RC0: 0>, overallstabilityec7bepartialfactorset=<PartialFactorSetEC7NADBE.RC1SET1: 0>, stabilitycurpartialfactorset=<PartialFactorSetCUR.CLASSI: 0>, partial_factors_eurocode_da1_set1=PartialFactorsEurocodeDa1Set1(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=0.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.35, effectfactorvarunfav=1.1, materialfactorcohesion=1.0, materialfactortgphi=1.0, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.0, overallstabilityfactortgphi=1.0, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=0.0, verticalbalancegammamb=1.25), partial_factors_eurocode_da1_set2=PartialFactorsEurocodeDa1Set2(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.3, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.25, materialfactortgphi=1.25, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.0, overallstabilityfactortgphi=1.0, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=0.0, verticalbalancegammamb=1.25), partial_factors_eurocode_da2=PartialFactorsEurocodeDa2(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.35, effectfactorvarunfav=1.1, materialfactorcohesion=1.0, materialfactortgphi=1.0, materialfactorsubgradereaction=1.0, resistancefactor=1.4, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.0, overallstabilityfactortgphi=1.0, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=0.0, verticalbalancegammamb=1.25), partial_factors_eurocode_da3=PartialFactorsEurocodeDa3(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.3, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.25, materialfactortgphi=1.25, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.0, overallstabilityfactortgphi=1.0, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=0.0, verticalbalancegammamb=1.25), partial_factors_ec7_nl_0=PartialFactorsEc7Nl0(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.0, materialfactortgphi=1.05, materialfactorsubgradereaction=1.3, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.15, geometrydeltaactivephreaticline=0.05, overallstabilityfactordrivingmoment=0.9, overallstabilityfactorcohesion=1.3, overallstabilityfactortgphi=1.2, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.2, verticalbalancegammamb=1.2), partial_factors_ec7_nl_1=PartialFactorsEc7Nl1(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.15, materialfactortgphi=1.15, materialfactorsubgradereaction=1.3, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.2, geometrydeltaactivephreaticline=0.05, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.3, overallstabilityfactortgphi=1.2, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.2, verticalbalancegammamb=1.25), partial_factors_ec7_nl_2=PartialFactorsEc7Nl2(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.25, materialfactortgphi=1.175, materialfactorsubgradereaction=1.3, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.25, geometrydeltaactivephreaticline=0.05, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.45, overallstabilityfactortgphi=1.25, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.2, verticalbalancegammamb=1.25), partial_factors_ec7_nl_3=PartialFactorsEc7Nl3(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.25, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.4, materialfactortgphi=1.2, materialfactorsubgradereaction=1.3, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.25, geometrydeltaactivephreaticline=0.05, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.6, overallstabilityfactortgphi=1.3, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.35, verticalbalancegammamb=1.25), partial_factors_ec7_be_1_set1=PartialFactorsEc7BE1Set1(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.2, effectfactorvarunfav=1.083, materialfactorcohesion=1.0, materialfactortgphi=1.0, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=0.0, geometrymaxincretainingheight=0.0, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.0, overallstabilityfactortgphi=1.0, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.0, verticalbalancegammamb=1.0), partial_factors_ec7_be_1_set2=PartialFactorsEc7BE1Set2(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.1, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.1, materialfactortgphi=1.1, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.3, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.1, overallstabilityfactortgphi=1.1, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=0.0, verticalbalancegammamb=1.3), partial_factors_ec7_be_2_set1=PartialFactorsEc7BE2Set1(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.35, effectfactorvarunfav=1.111, materialfactorcohesion=1.0, materialfactortgphi=1.0, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=0.0, geometrymaxincretainingheight=0.0, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.0, overallstabilityfactortgphi=1.0, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.0, verticalbalancegammamb=1.0), partial_factors_ec7_be_2_set2=PartialFactorsEc7BE2Set2(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.1, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.25, materialfactortgphi=1.25, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.3, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.25, overallstabilityfactortgphi=1.25, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.0, verticalbalancegammamb=1.3), partial_factors_ec7_be_3_set1=PartialFactorsEc7BE3Set1(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.5, effectfactorvarunfav=1.2, materialfactorcohesion=1.0, materialfactortgphi=1.0, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=0.0, geometrymaxincretainingheight=0.0, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.0, overallstabilityfactortgphi=1.0, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.0, verticalbalancegammamb=1.0), partial_factors_ec7_be_3_set2=PartialFactorsEc7BE3Set2(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.2, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.4, materialfactortgphi=1.4, materialfactorsubgradereaction=1.0, resistancefactor=1.0, geometryincretainingheight=10.0, geometrymaxincretainingheight=0.5, geometryincretainingheightdry=0.3, geometrydeltapassivesurfacelevel=0.0, geometrydeltapassivephreaticline=0.0, geometrydeltaactivephreaticline=0.0, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.4, overallstabilityfactortgphi=1.4, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=1.0, verticalbalancegammamb=1.3), partial_factors_cur_i=PartialFactorsCurI(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.0, materialfactortgphi=1.05, materialfactorsubgradereaction=1.3, resistancefactor=1.0, geometryincretainingheight=0.0, geometrymaxincretainingheight=0.0, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.2, geometrydeltapassivephreaticline=0.15, geometrydeltaactivephreaticline=0.05, overallstabilityfactordrivingmoment=0.9, overallstabilityfactorcohesion=1.5, overallstabilityfactortgphi=1.2, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=0.0, verticalbalancegammamb=1.25), partial_factors_cur_ii=PartialFactorsCurIi(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.0, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.0, materialfactortgphi=1.15, materialfactorsubgradereaction=1.3, resistancefactor=1.0, geometryincretainingheight=0.0, geometrymaxincretainingheight=0.0, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.3, geometrydeltapassivephreaticline=0.2, geometrydeltaactivephreaticline=0.05, overallstabilityfactordrivingmoment=1.0, overallstabilityfactorcohesion=1.5, overallstabilityfactortgphi=1.2, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=0.0, verticalbalancegammamb=1.25), partial_factors_cur_iii=PartialFactorsCurIii(loadfactorpermunfav=1.0, loadfactorpermfav=1.0, loadfactorvarunfav=1.25, loadfactorvarfav=0.0, constructloadfactorpermfav=1.0, constructloadfactorvarfav=1.0, constructloadfactorpermunfavcalc=1.0, constructloadfactorvarunfavcalc=1.0, effectfactor=1.0, effectfactorvarunfav=1.0, materialfactorcohesion=1.1, materialfactortgphi=1.2, materialfactorsubgradereaction=1.3, resistancefactor=1.0, geometryincretainingheight=0.0, geometrymaxincretainingheight=0.0, geometryincretainingheightdry=0.0, geometrydeltapassivesurfacelevel=0.35, geometrydeltapassivephreaticline=0.25, geometrydeltaactivephreaticline=0.05, overallstabilityfactordrivingmoment=1.1, overallstabilityfactorcohesion=1.5, overallstabilityfactortgphi=1.2, overallstabilityfactorunitweight=1.0, factorrepvaluesmdpmax=0.0, verticalbalancegammamb=1.25)), probabilistic_calculation_options='ZFunctionType=1\nZFunctionMobilisation=100.00\nZFunctionMoment=0.00\nZFunctionAnchorForce=0.00\nZFunctionAnchor=-1', probabilistic_control_parameters='IterationFactor=1.000\nIterationNumber=15\nCriteriaLimit1=0.010000\nCriteriaLimit2=0.010000\nReliabilityStage=0', soil_displacements=None, rigid_supports=None, spring_supports=None, moments=None, normal_forces=None, anchors=None, struts=None, vibration_positions=None), output_data=None)), 'filename': FieldInfo(annotation=Union[Path, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

property model_type: str | ModelType

property output: DSheetPilingOutputStructure

Access internal dict-like datastructure of the output.

Requires a successful execute.

property parser_provider_type: Type[DSheetPilingParserProvider]

Returns the parser provider type of the current concrete class.

Raises:

NotImplementedError – If not implemented in the concrete class.

Returns:

Type[BaseParserProvider] – Concrete parser provider.

property profiles

Enables easy access to the profiles in the internal dict-like datastructure.

Also enables edit/delete for individual Profiles.

serialize(filename)

Serialize model to input file.

Parameters:

filename (Union[Path, BinaryIO])

set_calculation_options(calculation_options)

Set calculation options.

Overall calculation options are set in [CALCULATION OPTIONS].

Parameters:

calculation_options (CalculationOptions) – Calculation options

Return type:

None

set_construction(top_level, elements)

Sets construction for the DSheetPilingModel.

Elements are added to [SHEET PILING]. Removes current sheetpiling when called.

Parameters:

• top_level (float) – Top level of the sheet piling.

• elements (List[Union[Sheet, DiaphragmWall, Pile]]) – List of sheet piling elements (can be Sheet, DiaphragmWall, or Pile elements) which are sorted on sheetpilingelementlevel.

Return type:

None

set_curve_settings(curve_settings)

Set curve settings for soil profiles.

Curve settings are set in [SOIL PROFILES].

Parameters:

curve_settings (CurveSettings) – Curvesettings

set_model(model)

(Re)Set BaseModelType (Pile, Sheet, Wall) for model.

Parameters:

model (BaseModelType)

Return type:

None

set_unit_weight_water(unit_weight)

Sets the unit weight for water in the [WATER] block

Parameters:

unit_weight (float)

Return type:

None

property sheets

Enables easy access to the sheets in the internal dict-like datastructure.

Also enables edit/delete for individual Sheets.

class geolib.models.dsheetpiling.dsheetpiling_model.DiaphragmModelType(**data)

Parameters:

data (Any)

check_vertical_balance: Optional[bool]

diepwand_calculation: bool

elastic_calculation: bool

method: Optional[LateralEarthPressureMethod]

property model: ModelType

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'check_vertical_balance': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'diepwand_calculation': FieldInfo(annotation=bool, required=False, default=True), 'elastic_calculation': FieldInfo(annotation=bool, required=False, default=False), 'method': FieldInfo(annotation=Union[LateralEarthPressureMethod, NoneType], required=False, default=None), 'verification': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

verification: Optional[bool]

class geolib.models.dsheetpiling.dsheetpiling_model.SheetModelType(**data)

Parameters:

data (Any)

check_vertical_balance: Optional[bool]

elastic_calculation: Optional[bool]

method: Optional[LateralEarthPressureMethod]

property model: ModelType

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'check_vertical_balance': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'elastic_calculation': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'method': FieldInfo(annotation=Union[LateralEarthPressureMethod, NoneType], required=False, default=None), 'reliability_analysis': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'trildens_calculation': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'verification': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

reliability_analysis: Optional[bool]

trildens_calculation: Optional[bool]

verification: Optional[bool]

class geolib.models.dsheetpiling.dsheetpiling_model.SinglePileModelType(**data)

Parameters:

data (Any)

elastic_calculation: Optional[bool]

property model: ModelType

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'elastic_calculation': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'pile_load_option': FieldInfo(annotation=Union[SinglePileLoadOptions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

pile_load_option: Optional[SinglePileLoadOptions]

class geolib.models.dsheetpiling.dsheetpiling_model.WoodenSheetPileModelType(**data)

Parameters:

data (Any)

check_vertical_balance: Optional[bool]

elastic_calculation: bool

method: Optional[LateralEarthPressureMethod]

property model: ModelType

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'check_vertical_balance': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'elastic_calculation': FieldInfo(annotation=bool, required=False, default=True), 'method': FieldInfo(annotation=Union[LateralEarthPressureMethod, NoneType], required=False, default=None), 'verification': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'wooden_sheetpiling': FieldInfo(annotation=bool, required=False, default=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

verification: Optional[bool]

wooden_sheetpiling: bool