geolib.models.dsheetpiling.calculation_options

Classes

CalculationOptions(**data)	Base class for all calculation options.
CalculationOptionsPerStage(**data)	Calculation options are needed when a verification calculation is performed with method B.
DesignSheetpilingLengthCalculationOptions(**data)	Design sheet pile calculation selected in Start Calculation window.
KranzAnchorStrengthCalculationOptions(**data)	Kranz anchor strength calculation selected in Start Calculation window.
OverallStabilityCalculationOptions(**data)	Overall stability calculation selected in Start Calculation window.
ReliabilityAnalysisCalculationOptions(**data)	Reliability analysis calculation selected in Start Calculation window.
StandardCalculationOptions(**data)	Standard calculation selected in Start Calculation window.
VerifyCalculationOptions(**data)	Verify sheet pile calculation selected in Start Calculation window.

class geolib.models.dsheetpiling.calculation_options.CalculationOptions(**data)

Base class for all calculation options.

Parameters:

• calc_first_stage_initial – This option determines equal neutral stresses at both sides, for initially non-horizontal surfaces or initial surcharges.

• calc_minor_nodes_on – Select either the faster, classic, coarse element determination (False) of active and passive pressures, or the more accurate fine element determination(True).

• calc_reduce_deltas – Set on True for reduction of the wall friction angles according to CUR 166 for the calculation of the passive earth pressure coefficients of Culmann method.

• input_calculation_type – select the type of calculation that is going to be performed.

• ec7_nl_assessment_type – Select the assessment type for a calculation with EC7-NL. This option is used only by the GUI in User Defined Partial Factors window.

• data (Any)

calc_first_stage_initial: bool

calc_minor_nodes_on: bool

calc_reduce_deltas: bool

property calculation_properties: StandardCalculationOptions | DesignSheetpilingLengthCalculationOptions | VerifyCalculationOptions | KranzAnchorStrengthCalculationOptions | OverallStabilityCalculationOptions | ReliabilityAnalysisCalculationOptions

ec7_nl_assessment_type: AssessmentTypeEC7NL

input_calculation_type: CalculationType

is_vibration_calculation: bool

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]] = {'calc_first_stage_initial': FieldInfo(annotation=bool, required=False, default=False), 'calc_minor_nodes_on': FieldInfo(annotation=bool, required=False, default=False), 'calc_reduce_deltas': FieldInfo(annotation=bool, required=False, default=False), 'ec7_nl_assessment_type': FieldInfo(annotation=AssessmentTypeEC7NL, required=False, default=<AssessmentTypeEC7NL.NewConstruction: 0>), 'input_calculation_type': FieldInfo(annotation=CalculationType, required=False, default=<CalculationType.STANDARD: 0>), 'is_vibration_calculation': FieldInfo(annotation=bool, required=False, default=False)}

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.calculation_options.CalculationOptionsPerStage(**data)

Calculation options are needed when a verification calculation is performed with method B. The user can specify a different partial factor set for each of the stages. This input is optional when another type of calculation is performed. :param anchor_factor: multiplication factor for the anchor stiffness. :param partial_factor_set: partial factor sets corresponding to different code annexes.

Parameters:

data (Any)

anchor_factor: float

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]] = {'anchor_factor': FieldInfo(annotation=float, required=False, default=1), 'partial_factor_set': FieldInfo(annotation=Union[PartialFactorSetEC7NADBE, PartialFactorSetCUR, PartialFactorSetEC7NADNL, 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.

partial_factor_set: Union[PartialFactorSetEC7NADBE, PartialFactorSetCUR, PartialFactorSetEC7NADNL, None]

class geolib.models.dsheetpiling.calculation_options.DesignSheetpilingLengthCalculationOptions(**data)

Design sheet pile calculation selected in Start Calculation window.

Note that design_pile_length can show up as a different value in the GUI compared to what’s been set in the .shi file.

Parameters:

• design_stage – Id of the stage to be checked. This id refers to D-SheetPiling so the first stage in D-SheetPiling has an input of 0.

• design_pile_length_from – The starting point of the pile over which the analysis should be performed.

• design_pile_length_to – The end point of the pile over which the analysis should be performed

• design_pile_length_decrement – the Decrement in length for each analysis step.

• design_type – types of design.

• design_eurocode_partial_factor_set – Select partial factor set

• design_partial_factor_set_ec7_nad_nl – Select partial factor set

• design_ec7_nl_method – Select method of calculation according to CUR 166 design procedure

• design_ec7_be_partial_factor_set – Select partial factor set

• design_ec7_be_method – Select method of calculation according to CUR 166 design procedure

• design_partial_factor_set – Select partial factor set

• design_cur_method – Select method of calculation according to CUR 166 design procedure

• data (Any)

design_cur_method: PartialFactorCalculationType

design_ec7_be_method: PartialFactorCalculationType

design_ec7_be_partial_factor_set: PartialFactorSetEC7NADBE

design_ec7_nl_method: PartialFactorCalculationType

design_eurocode_partial_factor_set: PartialFactorSetEC

design_partial_factor_set: PartialFactorSetCUR

design_partial_factor_set_ec7_nad_nl: PartialFactorSetEC7NADNL

design_pile_length_decrement: Annotated[float]

design_pile_length_from: Annotated[float]

design_pile_length_to: Annotated[float]

design_stage: Annotated[int]

design_type: DesignType

input_calculation_type: CalculationType

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]] = {'calc_first_stage_initial': FieldInfo(annotation=bool, required=False, default=False), 'calc_minor_nodes_on': FieldInfo(annotation=bool, required=False, default=False), 'calc_reduce_deltas': FieldInfo(annotation=bool, required=False, default=False), 'design_cur_method': FieldInfo(annotation=PartialFactorCalculationType, required=False, default=<PartialFactorCalculationType.METHODA: 0>), 'design_ec7_be_method': FieldInfo(annotation=PartialFactorCalculationType, required=False, default=<PartialFactorCalculationType.METHODA: 0>), 'design_ec7_be_partial_factor_set': FieldInfo(annotation=PartialFactorSetEC7NADBE, required=False, default=<PartialFactorSetEC7NADBE.RC1SET1: 0>), 'design_ec7_nl_method': FieldInfo(annotation=PartialFactorCalculationType, required=False, default=<PartialFactorCalculationType.METHODA: 0>), 'design_eurocode_partial_factor_set': FieldInfo(annotation=PartialFactorSetEC, required=False, default=<PartialFactorSetEC.DA1SET1: 0>), 'design_partial_factor_set': FieldInfo(annotation=PartialFactorSetCUR, required=False, default=<PartialFactorSetCUR.CLASSI: 0>), 'design_partial_factor_set_ec7_nad_nl': FieldInfo(annotation=PartialFactorSetEC7NADNL, required=False, default=<PartialFactorSetEC7NADNL.RC0: 0>), 'design_pile_length_decrement': FieldInfo(annotation=float, required=False, default=0.01, metadata=[Ge(ge=0.01), Le(le=10)]), 'design_pile_length_from': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=1), Le(le=100)]), 'design_pile_length_to': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=1), Le(le=100)]), 'design_stage': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=0)]), 'design_type': FieldInfo(annotation=DesignType, required=False, default=<DesignType.REPRESENTATIVE: 0>), 'ec7_nl_assessment_type': FieldInfo(annotation=AssessmentTypeEC7NL, required=False, default=<AssessmentTypeEC7NL.NewConstruction: 0>), 'input_calculation_type': FieldInfo(annotation=CalculationType, required=False, default=<CalculationType.DESIGN_SHEETPILING_LENGTH: 1>), 'is_vibration_calculation': FieldInfo(annotation=bool, required=False, default=False)}

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.calculation_options.KranzAnchorStrengthCalculationOptions(**data)

Kranz anchor strength calculation selected in Start Calculation window.

Parameters:

• cur_anchor_force_stage – Id of the stage to be checked. This id refers to D-SheetPiling so the first stage in D-SheetPiling has an input of 0.

• data (Any)

cur_anchor_force_stage: Annotated[int]

input_calculation_type: CalculationType

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]] = {'calc_first_stage_initial': FieldInfo(annotation=bool, required=False, default=False), 'calc_minor_nodes_on': FieldInfo(annotation=bool, required=False, default=False), 'calc_reduce_deltas': FieldInfo(annotation=bool, required=False, default=False), 'cur_anchor_force_stage': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=0)]), 'ec7_nl_assessment_type': FieldInfo(annotation=AssessmentTypeEC7NL, required=False, default=<AssessmentTypeEC7NL.NewConstruction: 0>), 'input_calculation_type': FieldInfo(annotation=CalculationType, required=False, default=<CalculationType.CHARACTERISTIC_KRANZ_ANCHOR_STRENGTH: 3>), 'is_vibration_calculation': FieldInfo(annotation=bool, required=False, default=False)}

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.calculation_options.OverallStabilityCalculationOptions(**data)

Overall stability calculation selected in Start Calculation window.

Parameters:

• cur_stability_stage – Id of the stage to be checked. This id refers to D-SheetPiling so the first stage in D-SheetPiling has an input of 0.

• overall_stability_type – which type of calculation is going to be performed

• stability_eurocode_partial_factor_set – partial factor set selected for the EC7 General calculation

• stability_ec7_nl_partial_factor_set – partial factor set selected for the EC7 NL calculation

• stability_ec7_be_partial_factor_set – partial factor set selected for the EC7 BE calculation

• stability_cur_partial_factor_set – partial factor set selected for the CUR calculation

• stability_export – Set on True to generate an input file with STI format which can be opened with D-Geo Stability

• data (Any)

cur_stability_stage: Annotated[int]

input_calculation_type: CalculationType

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]] = {'calc_first_stage_initial': FieldInfo(annotation=bool, required=False, default=False), 'calc_minor_nodes_on': FieldInfo(annotation=bool, required=False, default=False), 'calc_reduce_deltas': FieldInfo(annotation=bool, required=False, default=False), 'cur_stability_stage': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=0)]), 'ec7_nl_assessment_type': FieldInfo(annotation=AssessmentTypeEC7NL, required=False, default=<AssessmentTypeEC7NL.NewConstruction: 0>), 'input_calculation_type': FieldInfo(annotation=CalculationType, required=False, default=<CalculationType.OVERALL_STABILITY: 4>), 'is_vibration_calculation': FieldInfo(annotation=bool, required=False, default=False), 'overall_stability_ec7_be_partial_factor_set': FieldInfo(annotation=PartialFactorSetEC7NADBE, required=False, default=<PartialFactorSetEC7NADBE.RC1SET1: 0>), 'overall_stability_type': FieldInfo(annotation=DesignType, required=False, default=<DesignType.REPRESENTATIVE: 0>), 'stability_cur_partial_factor_set': FieldInfo(annotation=PartialFactorSetCUR, required=False, default=<PartialFactorSetCUR.CLASSI: 0>), 'stability_ec7_nl_partial_factor_set': FieldInfo(annotation=PartialFactorSetEC7NADNL, required=False, default=<PartialFactorSetEC7NADNL.RC0: 0>), 'stability_eurocode_partial_factor_set': FieldInfo(annotation=PartialFactorSetEC, required=False, default=<PartialFactorSetEC.DA1SET1: 0>), 'stability_export': FieldInfo(annotation=bool, required=False, default=False)}

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

This replaces Model.__fields__ from Pydantic V1.

overall_stability_ec7_be_partial_factor_set: PartialFactorSetEC7NADBE

overall_stability_type: DesignType

stability_cur_partial_factor_set: PartialFactorSetCUR

stability_ec7_nl_partial_factor_set: PartialFactorSetEC7NADNL

stability_eurocode_partial_factor_set: PartialFactorSetEC

stability_export: bool

class geolib.models.dsheetpiling.calculation_options.ReliabilityAnalysisCalculationOptions(**data)

Reliability analysis calculation selected in Start Calculation window.

Parameters:

data (Any)

input_calculation_type: CalculationType

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]] = {'calc_first_stage_initial': FieldInfo(annotation=bool, required=False, default=False), 'calc_minor_nodes_on': FieldInfo(annotation=bool, required=False, default=False), 'calc_reduce_deltas': FieldInfo(annotation=bool, required=False, default=False), 'ec7_nl_assessment_type': FieldInfo(annotation=AssessmentTypeEC7NL, required=False, default=<AssessmentTypeEC7NL.NewConstruction: 0>), 'input_calculation_type': FieldInfo(annotation=CalculationType, required=False, default=<CalculationType.RELIABILITY_ANALYSIS: 5>), 'is_vibration_calculation': FieldInfo(annotation=bool, required=False, default=False)}

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.calculation_options.StandardCalculationOptions(**data)

Standard calculation selected in Start Calculation window.

Parameters:

• calc_auto_lambdas_on – When True Automatic leaves the values of the lateral earth pressure ratios that are calculated by the Culmann (c, phi, delta) method as they are.

• data (Any)

calc_auto_lambdas_on: bool

input_calculation_type: CalculationType

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]] = {'calc_auto_lambdas_on': FieldInfo(annotation=bool, required=False, default=True), 'calc_first_stage_initial': FieldInfo(annotation=bool, required=False, default=False), 'calc_minor_nodes_on': FieldInfo(annotation=bool, required=False, default=False), 'calc_reduce_deltas': FieldInfo(annotation=bool, required=False, default=False), 'ec7_nl_assessment_type': FieldInfo(annotation=AssessmentTypeEC7NL, required=False, default=<AssessmentTypeEC7NL.NewConstruction: 0>), 'input_calculation_type': FieldInfo(annotation=CalculationType, required=False, default=<CalculationType.STANDARD: 0>), 'is_vibration_calculation': FieldInfo(annotation=bool, required=False, default=False)}

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.calculation_options.VerifyCalculationOptions(**data)

Verify sheet pile calculation selected in Start Calculation window.

Parameters:

• verify_type – Select partial factor set

• eurocode_partial_factor_set – Select partial factor set

• eurocode_overall_stability – Set to True to perform an overall stability calculation using modified values for soil properties (cohesion, friction angle and unit weight) depending on the Design approach chosen for all stages.

• ec7_nl_method – Select method of calculation according to CUR 166 design procedure

• ec7_nl_overall_partial_factor_set – Select partial factor set

• ec7_nl_overall_anchor_factor – multiplication factor for the anchor stiffness

• ec7_nad_nl_overall_stability – Set to True to perform an overall stability calculation using modified values for soil properties (cohesion, friction angle and unit weight) depending on the Design approach chosen for all stages.

• ec7_be_overall_stability – Set to True to perform an overall stability calculation using modified values for soil properties (cohesion, friction angle and unit weight) depending on the Design approach chosen for all stages.

• ec7_be_method – Select method of calculation for EC7 BE

• ec7_be_overall_risk_class – Select risk class

• cur_method – Select method of calculation according to CUR 166 design procedure

• cur_overall_partial_factor_set – Select partial factor set

• cur_overall_anchor_factor – multiplication factor for the anchor stiffness

• cur_overall_stability – Set to True to perform an overall stability calculation using modified values for soil properties (cohesion, friction angle and unit weight) depending on the Design approach chosen for all stages.

• data (Any)

property allowable_anchor_force_calculation_type: bool

cur_method: PartialFactorCalculationType

cur_overall_anchor_factor: Annotated[float]

cur_overall_partial_factor_set: PartialFactorSetCUR

cur_overall_stability: bool

ec7_be_method: PartialFactorCalculationType

ec7_be_overall_risk_class: RiskClassEC7BE

ec7_be_overall_stability: bool

ec7_nad_nl_overall_stability: bool

ec7_nl_method: PartialFactorCalculationType

ec7_nl_overall_anchor_factor: Annotated[float]

ec7_nl_overall_partial_factor_set: PartialFactorSetEC7NADNL

eurocode_overall_stability: bool

eurocode_partial_factor_set: PartialFactorSetVerifyEC

input_calculation_type: CalculationType

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]] = {'calc_first_stage_initial': FieldInfo(annotation=bool, required=False, default=False), 'calc_minor_nodes_on': FieldInfo(annotation=bool, required=False, default=False), 'calc_reduce_deltas': FieldInfo(annotation=bool, required=False, default=False), 'cur_method': FieldInfo(annotation=PartialFactorCalculationType, required=False, default=<PartialFactorCalculationType.METHODA: 0>), 'cur_overall_anchor_factor': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=0.001), Le(le=1000)]), 'cur_overall_partial_factor_set': FieldInfo(annotation=PartialFactorSetCUR, required=False, default=<PartialFactorSetCUR.CLASSI: 0>), 'cur_overall_stability': FieldInfo(annotation=bool, required=False, default=False), 'ec7_be_method': FieldInfo(annotation=PartialFactorCalculationType, required=False, default=<PartialFactorCalculationType.METHODA: 0>), 'ec7_be_overall_risk_class': FieldInfo(annotation=RiskClassEC7BE, required=False, default=<RiskClassEC7BE.RC2: 1>), 'ec7_be_overall_stability': FieldInfo(annotation=bool, required=False, default=False), 'ec7_nad_nl_overall_stability': FieldInfo(annotation=bool, required=False, default=False), 'ec7_nl_assessment_type': FieldInfo(annotation=AssessmentTypeEC7NL, required=False, default=<AssessmentTypeEC7NL.NewConstruction: 0>), 'ec7_nl_method': FieldInfo(annotation=PartialFactorCalculationType, required=False, default=<PartialFactorCalculationType.METHODA: 0>), 'ec7_nl_overall_anchor_factor': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=0.001), Le(le=1000)]), 'ec7_nl_overall_partial_factor_set': FieldInfo(annotation=PartialFactorSetEC7NADNL, required=False, default=<PartialFactorSetEC7NADNL.RC0: 0>), 'eurocode_overall_stability': FieldInfo(annotation=bool, required=False, default=False), 'eurocode_partial_factor_set': FieldInfo(annotation=PartialFactorSetVerifyEC, required=False, default=<PartialFactorSetVerifyEC.DA1: 0>), 'input_calculation_type': FieldInfo(annotation=CalculationType, required=False, default=<CalculationType.VERIFY_SHEETPILING: 2>), 'is_vibration_calculation': FieldInfo(annotation=bool, required=False, default=False), 'verify_type': FieldInfo(annotation=VerifyType, required=False, default=<VerifyType.CUR: 0>)}

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

This replaces Model.__fields__ from Pydantic V1.

verify_type: VerifyType