geolib.models.dsettlement.internal¶
Classes
|
Representation of [BOUNDARIES] group. |
|
|
|
|
|
|
|
|
|
Curve is a Line consisting of two points (by reference). |
|
Representation of [CURVES] group. |
|
Converting points from geolib co-ordinate system to the d-settlement UI Internal setting of the geometry differs from API. |
|
Representation of complete .sli file. |
|
Representation of complete .sld file, inheriting the structure of the .sli file as well. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Representation of [GEOMETRY DATA] group. |
|
|
|
|
|
|
|
Representation of [LAYERS] group. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Representation of [NON-UNIFORM LOADS] group. |
|
|
|
Representation of [OTHER LOADS] group. |
|
|
|
|
|
Representation of [PIEZO LINES] group. |
|
Different from DSeriePoint as it does not belong in [POINTS]. |
|
Representation of [POINTS] group. |
|
|
|
|
|
|
|
Representation of [RESIDUAL TIMES] group. |
|
Representation of [results] group in sld file. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Representation of [Vertical] group in sld file. |
|
|
|
Representation of [VERTICALS] group. |
|
|
|
Representation of [WATER LOADS] group. |
- class geolib.models.dsettlement.internal.Boundaries(*args, boundaries: List[Boundary] = [])¶
Representation of [BOUNDARIES] group.
- 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]] = {'boundaries': FieldInfo(annotation=List[Boundary], required=False, default=[])}¶
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.dsettlement.internal.Boundary(*args, id: Annotated[int, Ge(ge=0)] = 0, curves: List[int] = [])¶
-
curves:
List
[int
]¶
-
id:
Annotated
[int
]¶
- 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]] = {'curves': FieldInfo(annotation=List[int], required=False, default=[]), 'id': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=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.
-
curves:
- class geolib.models.dsettlement.internal.CalculationOptions(*args, precon_pressure_within_layer: PreconPressureWithinLayer = PreconPressureWithinLayer.CONSTANT_NO_CORRECTION, is_imaginary_surface: Bool = Bool.FALSE, imaginary_surface_layer: Annotated[int, Gt(gt=0)] | None = None, is_submerging: Bool = Bool.FALSE, use_end_time_for_fit: Bool = Bool.FALSE, is_maintain_profile: Bool = Bool.FALSE, maintain_profile_material_name: str = 'Superelevation', maintain_profile_time: Annotated[int, Ge(ge=0), Le(le=100000)] = 0, maintain_profile_gamma_dry: Annotated[float, Ge(ge=-100), Le(le=100)] = 10, maintain_profile_gamma_wet: Annotated[float, Ge(ge=-100), Le(le=100)] = 10, dispersion_conditions_layer_boundaries_top: DispersionConditionLayerBoundary = DispersionConditionLayerBoundary.DRAINED, dispersion_conditions_layer_boundaries_bottom: DispersionConditionLayerBoundary = DispersionConditionLayerBoundary.DRAINED, stress_distribution_soil: StressDistributionSoil = StressDistributionSoil.BUISMAN, stress_distribution_loads: StressDistributionLoads = StressDistributionLoads.SIMULATE, iteration_stop_criteria_submerging: Annotated[float, Ge(ge=0.0), Le(le=1.0)] = 0.0, iteration_stop_criteria_submerging_layer_height: Annotated[float, Ge(ge=0), Le(le=99.999)] = 0, maximum_iteration_steps_for_submerging: Annotated[int, Ge(ge=1), Le(le=100)] = 1, iteration_stop_criteria_desired_profile: Annotated[float, Ge(ge=0.0), Le(le=1.0)] = 0.1, load_column_width_imaginary_surface: Annotated[float, Ge(ge=0.05), Le(le=10000)] = 1, load_column_width_non_uniform_loads: Annotated[float, Ge(ge=0.05), Le(le=10000)] = 1, load_column_width_trapeziform_loads: Annotated[float, Ge(ge=0.05), Le(le=10000)] = 1, end_of_consolidation: Annotated[int, Ge(ge=1), Le(le=100000)] = 100000, number_of_subtime_steps: Annotated[int, Ge(ge=1), Le(le=100)] = 2, reference_time: Annotated[float, Ge(ge=0.001), Le(le=1000000)] = 1, dissipation: Bool = Bool.FALSE, x_coord_dissipation: float = 0.0, use_fit_factors: Bool = Bool.FALSE, x_coord_fit: float = 0.0, is_predict_settlements_omitting_additional_load_steps: Bool = Bool.FALSE)¶
-
dispersion_conditions_layer_boundaries_bottom:
DispersionConditionLayerBoundary
¶
-
dispersion_conditions_layer_boundaries_top:
DispersionConditionLayerBoundary
¶
-
end_of_consolidation:
Annotated
[int
]¶
-
imaginary_surface_layer:
Optional
[Annotated
[int
]]¶
-
iteration_stop_criteria_desired_profile:
Annotated
[float
]¶
-
iteration_stop_criteria_submerging:
Annotated
[float
]¶
-
iteration_stop_criteria_submerging_layer_height:
Annotated
[float
]¶
-
load_column_width_imaginary_surface:
Annotated
[float
]¶
-
load_column_width_non_uniform_loads:
Annotated
[float
]¶
-
load_column_width_trapeziform_loads:
Annotated
[float
]¶
-
maintain_profile_gamma_dry:
Annotated
[float
]¶
-
maintain_profile_gamma_wet:
Annotated
[float
]¶
-
maintain_profile_material_name:
str
¶
-
maintain_profile_time:
Annotated
[int
]¶
-
maximum_iteration_steps_for_submerging:
Annotated
[int
]¶
- 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]] = {'dispersion_conditions_layer_boundaries_bottom': FieldInfo(annotation=DispersionConditionLayerBoundary, required=False, default=<DispersionConditionLayerBoundary.DRAINED: 1>), 'dispersion_conditions_layer_boundaries_top': FieldInfo(annotation=DispersionConditionLayerBoundary, required=False, default=<DispersionConditionLayerBoundary.DRAINED: 1>), 'dissipation': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'end_of_consolidation': FieldInfo(annotation=int, required=False, default=100000, metadata=[Ge(ge=1), Le(le=100000)]), 'imaginary_surface_layer': FieldInfo(annotation=Union[Annotated[int, Gt], NoneType], required=False, default=None), 'is_imaginary_surface': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'is_maintain_profile': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'is_predict_settlements_omitting_additional_load_steps': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'is_submerging': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'iteration_stop_criteria_desired_profile': FieldInfo(annotation=float, required=False, default=0.1, metadata=[Ge(ge=0), Le(le=1)]), 'iteration_stop_criteria_submerging': FieldInfo(annotation=float, required=False, default=0.0, metadata=[Ge(ge=0.0), Le(le=1.0)]), 'iteration_stop_criteria_submerging_layer_height': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=0), Le(le=99.999)]), 'load_column_width_imaginary_surface': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=0.05), Le(le=10000)]), 'load_column_width_non_uniform_loads': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=0.05), Le(le=10000)]), 'load_column_width_trapeziform_loads': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=0.05), Le(le=10000)]), 'maintain_profile_gamma_dry': FieldInfo(annotation=float, required=False, default=10, metadata=[Ge(ge=-100), Le(le=100)]), 'maintain_profile_gamma_wet': FieldInfo(annotation=float, required=False, default=10, metadata=[Ge(ge=-100), Le(le=100)]), 'maintain_profile_material_name': FieldInfo(annotation=str, required=False, default='Superelevation'), 'maintain_profile_time': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=0), Le(le=100000)]), 'maximum_iteration_steps_for_submerging': FieldInfo(annotation=int, required=False, default=1, metadata=[Ge(ge=1), Le(le=100)]), 'number_of_subtime_steps': FieldInfo(annotation=int, required=False, default=2, metadata=[Ge(ge=1), Le(le=100)]), 'precon_pressure_within_layer': FieldInfo(annotation=PreconPressureWithinLayer, required=False, default=<PreconPressureWithinLayer.CONSTANT_NO_CORRECTION: 0>), 'reference_time': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=0.001), Le(le=1000000)]), 'stress_distribution_loads': FieldInfo(annotation=StressDistributionLoads, required=False, default=<StressDistributionLoads.SIMULATE: 1>), 'stress_distribution_soil': FieldInfo(annotation=StressDistributionSoil, required=False, default=<StressDistributionSoil.BUISMAN: 0>), 'use_end_time_for_fit': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'use_fit_factors': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'x_coord_dissipation': FieldInfo(annotation=float, required=False, default=0.0), 'x_coord_fit': FieldInfo(annotation=float, required=False, default=0.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.
-
number_of_subtime_steps:
Annotated
[int
]¶
-
precon_pressure_within_layer:
PreconPressureWithinLayer
¶
-
reference_time:
Annotated
[float
]¶
- classmethod set_imaginary_surface_options(**kwargs)¶
-
stress_distribution_loads:
StressDistributionLoads
¶
-
stress_distribution_soil:
StressDistributionSoil
¶
-
x_coord_dissipation:
float
¶
-
x_coord_fit:
float
¶
-
dispersion_conditions_layer_boundaries_bottom:
- class geolib.models.dsettlement.internal.CalculationSettings(*args, is_secondary_swelling_used: bool = False)¶
-
is_secondary_swelling_used:
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]] = {'is_secondary_swelling_used': 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.
-
is_secondary_swelling_used:
- class geolib.models.dsettlement.internal.ConsolidationModel(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- DARCY = 0¶
- TERZAGHI = 1¶
- class geolib.models.dsettlement.internal.Curve(*args, id: Annotated[int, Gt(gt=0)] = 1, points: Annotated[List[int], MinLen(min_length=2), MaxLen(max_length=2)])¶
Curve is a Line consisting of two points (by reference).
-
id:
Annotated
[int
]¶
- 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]] = {'id': FieldInfo(annotation=int, required=False, default=1, metadata=[Gt(gt=0)]), 'points': FieldInfo(annotation=List[int], required=True, metadata=[MinLen(min_length=2), MaxLen(max_length=2)])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
points:
Annotated
[List
[int
]]¶
-
id:
- class geolib.models.dsettlement.internal.Curves(*args, curves: List[Curve] = [])¶
Representation of [CURVES] group.
- create_curve(a, b)¶
- Parameters:
a (
DSeriePoint
)b (
DSeriePoint
)
- create_curves(sorted_points)¶
- Parameters:
sorted_points (
List
[DSeriePoint
])- Return type:
List
[Curve
]
- 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]] = {'curves': FieldInfo(annotation=List[Curve], required=False, default=[])}¶
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.dsettlement.internal.DSeriePoint(*args, id: Annotated[int, Gt(gt=0)], X: float, Y: float, Z: float, tolerance: float = 1e-10)¶
Converting points from geolib co-ordinate system to the d-settlement UI Internal setting of the geometry differs from API. Here co-ordinate system is the same as in the the d-settlement UI. So axis z of the geolib needs to be modified to y axis, which represents the depth.
-
X:
float
¶
-
Y:
float
¶
-
Z:
float
¶
- classmethod get_structure_required_fields()¶
Allows concrete classes to filter out fields that would normally be parsed.
- Returns:
List of Tuples[FieldName, FieldType]
- Return type:
List[Tuple[str, Type]]
-
id:
Annotated
[int
]¶
- 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]] = {'X': FieldInfo(annotation=float, required=True), 'Y': FieldInfo(annotation=float, required=True), 'Z': FieldInfo(annotation=float, required=True), 'id': FieldInfo(annotation=int, required=True, metadata=[Gt(gt=0)]), 'tolerance': FieldInfo(annotation=float, required=False, default=1e-10)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
tolerance:
float
¶
-
X:
- class geolib.models.dsettlement.internal.DSettlementInputStructure(*args, version: ~geolib.models.dsettlement.internal.Version = Version(soil=1011, geometry=1002, d__settlement=1011), soil_collection: ~geolib.models.dsettlement.internal.SoilCollection = SoilCollection(soil=[]), geometry_data: ~geolib.models.dsettlement.internal.GeometryData = GeometryData(points=Points(points=[]), curves=Curves(curves=[]), boundaries=Boundaries(boundaries=[]), use_probabilistic_defaults_boundaries=UseProbabilisticDefaultsBoundaries(useprobabilisticdefaultsboundaries=[]), stdv_boundaries=StdvBoundaries(stdvboundaries=[]), distribution_boundaries=DistributionBoundaries(distributionboundaries=[]), piezo_lines=PiezoLines(piezolines=[]), phreatic_line=PhreaticLine(phreatic_line=0), layers=Layers(layers=[])), geometry_1d_data: str | None = None, run_identification: str = '\n\n', model: ~geolib.models.dsettlement.internal.Model = Model(dimension=<Dimension.TWO_D: 1>, consolidation_model=<ConsolidationModel.DARCY: 0>, soil_model=<SoilModel.NEN_KOPPEJAN: 0>, strain_type=<StrainType.LINEAR: 0>, is_vertical_drains=<Bool.FALSE: 0>, is_fit_for_settlement_plate=<Bool.FALSE: 0>, is_probabilistic=<Bool.FALSE: 0>, is_horizontal_displacements=<Bool.FALSE: 0>, is_secondary_swelling=<Bool.FALSE: 0>), verticals: ~geolib.models.dsettlement.internal.Verticals | str = Verticals(locations=[]), water: float | str = 9.81, non__uniform_loads: ~geolib.models.dsettlement.internal.NonUniformLoads | str = NonUniformLoads(loads={}), water_loads: ~geolib.models.dsettlement.internal.WaterLoads | str = WaterLoads(waterloads=[]), other_loads: ~geolib.models.dsettlement.internal.OtherLoads | str = OtherLoads(loads={}), calculation_options: ~geolib.models.dsettlement.internal.CalculationOptions | str = CalculationOptions(precon_pressure_within_layer=<PreconPressureWithinLayer.CONSTANT_NO_CORRECTION: 0>, is_imaginary_surface=<Bool.FALSE: 0>, imaginary_surface_layer=None, is_submerging=<Bool.FALSE: 0>, use_end_time_for_fit=<Bool.FALSE: 0>, is_maintain_profile=<Bool.FALSE: 0>, maintain_profile_material_name='Superelevation', maintain_profile_time=0, maintain_profile_gamma_dry=10.0, maintain_profile_gamma_wet=10.0, dispersion_conditions_layer_boundaries_top=<DispersionConditionLayerBoundary.DRAINED: 1>, dispersion_conditions_layer_boundaries_bottom=<DispersionConditionLayerBoundary.DRAINED: 1>, stress_distribution_soil=<StressDistributionSoil.BUISMAN: 0>, stress_distribution_loads=<StressDistributionLoads.SIMULATE: 1>, iteration_stop_criteria_submerging=0.0, iteration_stop_criteria_submerging_layer_height=0.0, maximum_iteration_steps_for_submerging=1, iteration_stop_criteria_desired_profile=0.1, load_column_width_imaginary_surface=1.0, load_column_width_non_uniform_loads=1.0, load_column_width_trapeziform_loads=1.0, end_of_consolidation=100000, number_of_subtime_steps=2, reference_time=1.0, dissipation=<Bool.FALSE: 0>, x_coord_dissipation=0.0, use_fit_factors=<Bool.FALSE: 0>, x_coord_fit=0.0, is_predict_settlements_omitting_additional_load_steps=<Bool.FALSE: 0>), residual_times: ~geolib.models.dsettlement.internal.ResidualTimes | str = ResidualTimes(time_steps=[]), filter_band_width: str = '1 : Number of items\n0.05', vertical_drain: ~geolib.models.dsettlement.internal.VerticalDrain | str = VerticalDrain(drain_type=<DrainType.STRIP: 0>, range_from=0.0, range_to=0.0, bottom_position=0.0, center_to_center=3.0, width=0.1, diameter=0.1, thickness=0.003, grid=<DrainGridType.UNDERDETERMINED: 2>, schedule_type=<DrainSchedule.OFF: 0>, begin_time=0.0, end_time=0.0, under_pressure_for_strips_and_columns=35.0, under_pressure_for_sand_wall=35.0, start_of_drainage=0.0, phreatic_level_in_drain=0.0, water_head_during_dewatering=0.0, tube_pressure_during_dewatering=0.0, time=[], underpressure=[], water_level=[]), probabilistic_data: ~geolib.models.dsettlement.internal.ProbabilisticData = ProbabilisticData(reliability_x_co__ordinate=0.0, residual_settlement=1.0, maximum_drawings=100, maximum_iterations=15, reliability_type=<InternalProbabilisticCalculationType.FOSMOrDeterministic: 0>, is_reliability_calculation=<Bool.FALSE: 0>), probabilistic_defaults: str = 'ProbDefGamDryVar=0.05\nProbDefGamWetVar=0.05\nProbDefPOPVar=0.25\nProbDefOCRVar=0.25\nProbDefPcVar=0.25\nProbDefPermeabilityVerVar=2.50\nProbDefRatioHorVerPermeabilityCvVar=0.25\nProbDefCvVar=0.50\nProbDefCpVar=0.30\nProbDefCp1Var=0.30\nProbDefCsVar=0.30\nProbDefCs1Var=0.30\nProbDefApVar=0.30\nProbDefASecVar=0.30\nProbDefRRCrVar=0.25\nProbDefCRCcVar=0.25\nProbDefCaVar=0.25\nProbDefPriCompIndexVar=0.25\nProbDefSecCompIndexVar=0.25\nProbDefSecCompRateVar=0.25\nProbDefCpCor=0.01\nProbDefCsCor=0.01\nProbDefCs1Cor=0.01\nProbDefApCor=0.01\nProbDefASecCor=0.01\nProbDefRRCrCor=0.01\nProbDefCaCor=0.01\nProbDefPriCompIndexCor=0.01\nProbDefSecCompRateCor=0.01\nProbDefGamDryDist=2\nProbDefGamWetDist=2\nProbDefPOPDist=2\nProbDefOCRDist=2\nProbDefPcDist=2\nProbDefPermeabilityVerDist=2\nProbDefRatioHorVerPermeabilityCvDist=2\nProbDefCvDist=2\nProbDefCpDist=2\nProbDefCp1Dist=2\nProbDefCsDist=2\nProbDefCs1Dist=2\nProbDefApDist=2\nProbDefASecDist=2\nProbDefRRCrDist=2\nProbDefCRCcDist=2\nProbDefCaDist=2\nProbDefPriCompIndexDist=2\nProbDefSecCompIndexDist=2\nProbDefSecCompRateDist=2\nProbDefLayerStd=0.10\nProbDefLayerDist=0', fit_options: ~geolib.models.dsettlement.internal.FitOptions = FitOptions(fit_maximum_number_of_iterations=5, fit_required_iteration_accuracy=0.0001, fit_required_correlation_coefficient=0.99), fit_calculation: ~geolib.models.dsettlement.internal.FitCalculation = FitCalculation(is_fit_calculation=<Bool.FALSE: 0>, fit_vertical_number=0), fit: str = ' 0 = number of items')¶
Representation of complete .sli file.
-
calculation_options:
Union
[CalculationOptions
,str
]¶
-
filter_band_width:
str
¶
-
fit:
str
¶
-
fit_calculation:
FitCalculation
¶
-
fit_options:
FitOptions
¶
-
geometry_1d_data:
Optional
[str
]¶
-
geometry_data:
GeometryData
¶
- get_headlines_for_layers()¶
- 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]] = {'calculation_options': FieldInfo(annotation=Union[CalculationOptions, str], required=False, default=CalculationOptions(precon_pressure_within_layer=<PreconPressureWithinLayer.CONSTANT_NO_CORRECTION: 0>, is_imaginary_surface=<Bool.FALSE: 0>, imaginary_surface_layer=None, is_submerging=<Bool.FALSE: 0>, use_end_time_for_fit=<Bool.FALSE: 0>, is_maintain_profile=<Bool.FALSE: 0>, maintain_profile_material_name='Superelevation', maintain_profile_time=0, maintain_profile_gamma_dry=10.0, maintain_profile_gamma_wet=10.0, dispersion_conditions_layer_boundaries_top=<DispersionConditionLayerBoundary.DRAINED: 1>, dispersion_conditions_layer_boundaries_bottom=<DispersionConditionLayerBoundary.DRAINED: 1>, stress_distribution_soil=<StressDistributionSoil.BUISMAN: 0>, stress_distribution_loads=<StressDistributionLoads.SIMULATE: 1>, iteration_stop_criteria_submerging=0.0, iteration_stop_criteria_submerging_layer_height=0.0, maximum_iteration_steps_for_submerging=1, iteration_stop_criteria_desired_profile=0.1, load_column_width_imaginary_surface=1.0, load_column_width_non_uniform_loads=1.0, load_column_width_trapeziform_loads=1.0, end_of_consolidation=100000, number_of_subtime_steps=2, reference_time=1.0, dissipation=<Bool.FALSE: 0>, x_coord_dissipation=0.0, use_fit_factors=<Bool.FALSE: 0>, x_coord_fit=0.0, is_predict_settlements_omitting_additional_load_steps=<Bool.FALSE: 0>)), 'filter_band_width': FieldInfo(annotation=str, required=False, default='1 : Number of items\n0.05'), 'fit': FieldInfo(annotation=str, required=False, default=' 0 = number of items'), 'fit_calculation': FieldInfo(annotation=FitCalculation, required=False, default=FitCalculation(is_fit_calculation=<Bool.FALSE: 0>, fit_vertical_number=0)), 'fit_options': FieldInfo(annotation=FitOptions, required=False, default=FitOptions(fit_maximum_number_of_iterations=5, fit_required_iteration_accuracy=0.0001, fit_required_correlation_coefficient=0.99)), 'geometry_1d_data': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'geometry_data': FieldInfo(annotation=GeometryData, required=False, default=GeometryData(points=Points(points=[]), curves=Curves(curves=[]), boundaries=Boundaries(boundaries=[]), use_probabilistic_defaults_boundaries=UseProbabilisticDefaultsBoundaries(useprobabilisticdefaultsboundaries=[]), stdv_boundaries=StdvBoundaries(stdvboundaries=[]), distribution_boundaries=DistributionBoundaries(distributionboundaries=[]), piezo_lines=PiezoLines(piezolines=[]), phreatic_line=PhreaticLine(phreatic_line=0), layers=Layers(layers=[]))), 'model': FieldInfo(annotation=Model, required=False, default=Model(dimension=<Dimension.TWO_D: 1>, consolidation_model=<ConsolidationModel.DARCY: 0>, soil_model=<SoilModel.NEN_KOPPEJAN: 0>, strain_type=<StrainType.LINEAR: 0>, is_vertical_drains=<Bool.FALSE: 0>, is_fit_for_settlement_plate=<Bool.FALSE: 0>, is_probabilistic=<Bool.FALSE: 0>, is_horizontal_displacements=<Bool.FALSE: 0>, is_secondary_swelling=<Bool.FALSE: 0>)), 'non__uniform_loads': FieldInfo(annotation=Union[NonUniformLoads, str], required=False, default=NonUniformLoads(loads={})), 'other_loads': FieldInfo(annotation=Union[OtherLoads, str], required=False, default=OtherLoads(loads={})), 'probabilistic_data': FieldInfo(annotation=ProbabilisticData, required=False, default=ProbabilisticData(reliability_x_co__ordinate=0.0, residual_settlement=1.0, maximum_drawings=100, maximum_iterations=15, reliability_type=<InternalProbabilisticCalculationType.FOSMOrDeterministic: 0>, is_reliability_calculation=<Bool.FALSE: 0>)), 'probabilistic_defaults': FieldInfo(annotation=str, required=False, default='ProbDefGamDryVar=0.05\nProbDefGamWetVar=0.05\nProbDefPOPVar=0.25\nProbDefOCRVar=0.25\nProbDefPcVar=0.25\nProbDefPermeabilityVerVar=2.50\nProbDefRatioHorVerPermeabilityCvVar=0.25\nProbDefCvVar=0.50\nProbDefCpVar=0.30\nProbDefCp1Var=0.30\nProbDefCsVar=0.30\nProbDefCs1Var=0.30\nProbDefApVar=0.30\nProbDefASecVar=0.30\nProbDefRRCrVar=0.25\nProbDefCRCcVar=0.25\nProbDefCaVar=0.25\nProbDefPriCompIndexVar=0.25\nProbDefSecCompIndexVar=0.25\nProbDefSecCompRateVar=0.25\nProbDefCpCor=0.01\nProbDefCsCor=0.01\nProbDefCs1Cor=0.01\nProbDefApCor=0.01\nProbDefASecCor=0.01\nProbDefRRCrCor=0.01\nProbDefCaCor=0.01\nProbDefPriCompIndexCor=0.01\nProbDefSecCompRateCor=0.01\nProbDefGamDryDist=2\nProbDefGamWetDist=2\nProbDefPOPDist=2\nProbDefOCRDist=2\nProbDefPcDist=2\nProbDefPermeabilityVerDist=2\nProbDefRatioHorVerPermeabilityCvDist=2\nProbDefCvDist=2\nProbDefCpDist=2\nProbDefCp1Dist=2\nProbDefCsDist=2\nProbDefCs1Dist=2\nProbDefApDist=2\nProbDefASecDist=2\nProbDefRRCrDist=2\nProbDefCRCcDist=2\nProbDefCaDist=2\nProbDefPriCompIndexDist=2\nProbDefSecCompIndexDist=2\nProbDefSecCompRateDist=2\nProbDefLayerStd=0.10\nProbDefLayerDist=0'), 'residual_times': FieldInfo(annotation=Union[ResidualTimes, str], required=False, default=ResidualTimes(time_steps=[])), 'run_identification': FieldInfo(annotation=str, required=False, default='\n\n'), 'soil_collection': FieldInfo(annotation=SoilCollection, required=False, default=SoilCollection(soil=[])), 'version': FieldInfo(annotation=Version, required=False, default=Version(soil=1011, geometry=1002, d__settlement=1011)), 'vertical_drain': FieldInfo(annotation=Union[VerticalDrain, str], required=False, default=VerticalDrain(drain_type=<DrainType.STRIP: 0>, range_from=0.0, range_to=0.0, bottom_position=0.0, center_to_center=3.0, width=0.1, diameter=0.1, thickness=0.003, grid=<DrainGridType.UNDERDETERMINED: 2>, schedule_type=<DrainSchedule.OFF: 0>, begin_time=0.0, end_time=0.0, under_pressure_for_strips_and_columns=35.0, under_pressure_for_sand_wall=35.0, start_of_drainage=0.0, phreatic_level_in_drain=0.0, water_head_during_dewatering=0.0, tube_pressure_during_dewatering=0.0, time=[], underpressure=[], water_level=[])), 'verticals': FieldInfo(annotation=Union[Verticals, str], required=False, default=Verticals(locations=[])), 'water': FieldInfo(annotation=Union[float, str], required=False, default=9.81), 'water_loads': FieldInfo(annotation=Union[WaterLoads, str], required=False, default=WaterLoads(waterloads=[]))}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
non__uniform_loads:
Union
[NonUniformLoads
,str
]¶
-
other_loads:
Union
[OtherLoads
,str
]¶
-
probabilistic_data:
ProbabilisticData
¶
-
probabilistic_defaults:
str
¶
-
residual_times:
Union
[ResidualTimes
,str
]¶
-
run_identification:
str
¶
-
soil_collection:
SoilCollection
¶
- validate_options()¶
- Todo validation calculation options with geometry. I.e. validate x coordinate related options and layer related
options
Returns:
-
vertical_drain:
Union
[VerticalDrain
,str
]¶
-
water:
Union
[float
,str
]¶
-
water_loads:
Union
[WaterLoads
,str
]¶
-
calculation_options:
- class geolib.models.dsettlement.internal.DSettlementOutputStructure(*args, results: Results, input_data: DSettlementInputStructure)¶
Representation of complete .sld file, inheriting the structure of the .sli file as well.
-
input_data:
DSettlementInputStructure
¶
- 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]] = {'input_data': FieldInfo(annotation=DSettlementInputStructure, required=True), 'results': FieldInfo(annotation=Results, required=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.
-
input_data:
- class geolib.models.dsettlement.internal.DSettlementStructure(*args, input_data: ~geolib.models.dsettlement.internal.DSettlementInputStructure = DSettlementInputStructure(version=Version(soil=1011, geometry=1002, d__settlement=1011), soil_collection=SoilCollection(soil=[]), geometry_data=GeometryData(points=Points(points=[]), curves=Curves(curves=[]), boundaries=Boundaries(boundaries=[]), use_probabilistic_defaults_boundaries=UseProbabilisticDefaultsBoundaries(useprobabilisticdefaultsboundaries=[]), stdv_boundaries=StdvBoundaries(stdvboundaries=[]), distribution_boundaries=DistributionBoundaries(distributionboundaries=[]), piezo_lines=PiezoLines(piezolines=[]), phreatic_line=PhreaticLine(phreatic_line=0), layers=Layers(layers=[])), geometry_1d_data=None, run_identification='\n\n', model=Model(dimension=<Dimension.TWO_D: 1>, consolidation_model=<ConsolidationModel.DARCY: 0>, soil_model=<SoilModel.NEN_KOPPEJAN: 0>, strain_type=<StrainType.LINEAR: 0>, is_vertical_drains=<Bool.FALSE: 0>, is_fit_for_settlement_plate=<Bool.FALSE: 0>, is_probabilistic=<Bool.FALSE: 0>, is_horizontal_displacements=<Bool.FALSE: 0>, is_secondary_swelling=<Bool.FALSE: 0>), verticals=Verticals(locations=[]), water=9.81, non__uniform_loads=NonUniformLoads(loads={}), water_loads=WaterLoads(waterloads=[]), other_loads=OtherLoads(loads={}), calculation_options=CalculationOptions(precon_pressure_within_layer=<PreconPressureWithinLayer.CONSTANT_NO_CORRECTION: 0>, is_imaginary_surface=<Bool.FALSE: 0>, imaginary_surface_layer=None, is_submerging=<Bool.FALSE: 0>, use_end_time_for_fit=<Bool.FALSE: 0>, is_maintain_profile=<Bool.FALSE: 0>, maintain_profile_material_name='Superelevation', maintain_profile_time=0, maintain_profile_gamma_dry=10.0, maintain_profile_gamma_wet=10.0, dispersion_conditions_layer_boundaries_top=<DispersionConditionLayerBoundary.DRAINED: 1>, dispersion_conditions_layer_boundaries_bottom=<DispersionConditionLayerBoundary.DRAINED: 1>, stress_distribution_soil=<StressDistributionSoil.BUISMAN: 0>, stress_distribution_loads=<StressDistributionLoads.SIMULATE: 1>, iteration_stop_criteria_submerging=0.0, iteration_stop_criteria_submerging_layer_height=0.0, maximum_iteration_steps_for_submerging=1, iteration_stop_criteria_desired_profile=0.1, load_column_width_imaginary_surface=1.0, load_column_width_non_uniform_loads=1.0, load_column_width_trapeziform_loads=1.0, end_of_consolidation=100000, number_of_subtime_steps=2, reference_time=1.0, dissipation=<Bool.FALSE: 0>, x_coord_dissipation=0.0, use_fit_factors=<Bool.FALSE: 0>, x_coord_fit=0.0, is_predict_settlements_omitting_additional_load_steps=<Bool.FALSE: 0>), residual_times=ResidualTimes(time_steps=[]), filter_band_width='1 : Number of items\n0.05', vertical_drain=VerticalDrain(drain_type=<DrainType.STRIP: 0>, range_from=0.0, range_to=0.0, bottom_position=0.0, center_to_center=3.0, width=0.1, diameter=0.1, thickness=0.003, grid=<DrainGridType.UNDERDETERMINED: 2>, schedule_type=<DrainSchedule.OFF: 0>, begin_time=0.0, end_time=0.0, under_pressure_for_strips_and_columns=35.0, under_pressure_for_sand_wall=35.0, start_of_drainage=0.0, phreatic_level_in_drain=0.0, water_head_during_dewatering=0.0, tube_pressure_during_dewatering=0.0, time=[], underpressure=[], water_level=[]), probabilistic_data=ProbabilisticData(reliability_x_co__ordinate=0.0, residual_settlement=1.0, maximum_drawings=100, maximum_iterations=15, reliability_type=<InternalProbabilisticCalculationType.FOSMOrDeterministic: 0>, is_reliability_calculation=<Bool.FALSE: 0>), probabilistic_defaults='ProbDefGamDryVar=0.05\nProbDefGamWetVar=0.05\nProbDefPOPVar=0.25\nProbDefOCRVar=0.25\nProbDefPcVar=0.25\nProbDefPermeabilityVerVar=2.50\nProbDefRatioHorVerPermeabilityCvVar=0.25\nProbDefCvVar=0.50\nProbDefCpVar=0.30\nProbDefCp1Var=0.30\nProbDefCsVar=0.30\nProbDefCs1Var=0.30\nProbDefApVar=0.30\nProbDefASecVar=0.30\nProbDefRRCrVar=0.25\nProbDefCRCcVar=0.25\nProbDefCaVar=0.25\nProbDefPriCompIndexVar=0.25\nProbDefSecCompIndexVar=0.25\nProbDefSecCompRateVar=0.25\nProbDefCpCor=0.01\nProbDefCsCor=0.01\nProbDefCs1Cor=0.01\nProbDefApCor=0.01\nProbDefASecCor=0.01\nProbDefRRCrCor=0.01\nProbDefCaCor=0.01\nProbDefPriCompIndexCor=0.01\nProbDefSecCompRateCor=0.01\nProbDefGamDryDist=2\nProbDefGamWetDist=2\nProbDefPOPDist=2\nProbDefOCRDist=2\nProbDefPcDist=2\nProbDefPermeabilityVerDist=2\nProbDefRatioHorVerPermeabilityCvDist=2\nProbDefCvDist=2\nProbDefCpDist=2\nProbDefCp1Dist=2\nProbDefCsDist=2\nProbDefCs1Dist=2\nProbDefApDist=2\nProbDefASecDist=2\nProbDefRRCrDist=2\nProbDefCRCcDist=2\nProbDefCaDist=2\nProbDefPriCompIndexDist=2\nProbDefSecCompIndexDist=2\nProbDefSecCompRateDist=2\nProbDefLayerStd=0.10\nProbDefLayerDist=0', fit_options=FitOptions(fit_maximum_number_of_iterations=5, fit_required_iteration_accuracy=0.0001, fit_required_correlation_coefficient=0.99), fit_calculation=FitCalculation(is_fit_calculation=<Bool.FALSE: 0>, fit_vertical_number=0), fit=' 0 = number of items'), output_data: ~geolib.models.dsettlement.internal.Results | None = None)¶
-
input_data:
DSettlementInputStructure
¶
- 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]] = {'input_data': FieldInfo(annotation=DSettlementInputStructure, required=False, default=DSettlementInputStructure(version=Version(soil=1011, geometry=1002, d__settlement=1011), soil_collection=SoilCollection(soil=[]), geometry_data=GeometryData(points=Points(points=[]), curves=Curves(curves=[]), boundaries=Boundaries(boundaries=[]), use_probabilistic_defaults_boundaries=UseProbabilisticDefaultsBoundaries(useprobabilisticdefaultsboundaries=[]), stdv_boundaries=StdvBoundaries(stdvboundaries=[]), distribution_boundaries=DistributionBoundaries(distributionboundaries=[]), piezo_lines=PiezoLines(piezolines=[]), phreatic_line=PhreaticLine(phreatic_line=0), layers=Layers(layers=[])), geometry_1d_data=None, run_identification='\n\n', model=Model(dimension=<Dimension.TWO_D: 1>, consolidation_model=<ConsolidationModel.DARCY: 0>, soil_model=<SoilModel.NEN_KOPPEJAN: 0>, strain_type=<StrainType.LINEAR: 0>, is_vertical_drains=<Bool.FALSE: 0>, is_fit_for_settlement_plate=<Bool.FALSE: 0>, is_probabilistic=<Bool.FALSE: 0>, is_horizontal_displacements=<Bool.FALSE: 0>, is_secondary_swelling=<Bool.FALSE: 0>), verticals=Verticals(locations=[]), water=9.81, non__uniform_loads=NonUniformLoads(loads={}), water_loads=WaterLoads(waterloads=[]), other_loads=OtherLoads(loads={}), calculation_options=CalculationOptions(precon_pressure_within_layer=<PreconPressureWithinLayer.CONSTANT_NO_CORRECTION: 0>, is_imaginary_surface=<Bool.FALSE: 0>, imaginary_surface_layer=None, is_submerging=<Bool.FALSE: 0>, use_end_time_for_fit=<Bool.FALSE: 0>, is_maintain_profile=<Bool.FALSE: 0>, maintain_profile_material_name='Superelevation', maintain_profile_time=0, maintain_profile_gamma_dry=10.0, maintain_profile_gamma_wet=10.0, dispersion_conditions_layer_boundaries_top=<DispersionConditionLayerBoundary.DRAINED: 1>, dispersion_conditions_layer_boundaries_bottom=<DispersionConditionLayerBoundary.DRAINED: 1>, stress_distribution_soil=<StressDistributionSoil.BUISMAN: 0>, stress_distribution_loads=<StressDistributionLoads.SIMULATE: 1>, iteration_stop_criteria_submerging=0.0, iteration_stop_criteria_submerging_layer_height=0.0, maximum_iteration_steps_for_submerging=1, iteration_stop_criteria_desired_profile=0.1, load_column_width_imaginary_surface=1.0, load_column_width_non_uniform_loads=1.0, load_column_width_trapeziform_loads=1.0, end_of_consolidation=100000, number_of_subtime_steps=2, reference_time=1.0, dissipation=<Bool.FALSE: 0>, x_coord_dissipation=0.0, use_fit_factors=<Bool.FALSE: 0>, x_coord_fit=0.0, is_predict_settlements_omitting_additional_load_steps=<Bool.FALSE: 0>), residual_times=ResidualTimes(time_steps=[]), filter_band_width='1 : Number of items\n0.05', vertical_drain=VerticalDrain(drain_type=<DrainType.STRIP: 0>, range_from=0.0, range_to=0.0, bottom_position=0.0, center_to_center=3.0, width=0.1, diameter=0.1, thickness=0.003, grid=<DrainGridType.UNDERDETERMINED: 2>, schedule_type=<DrainSchedule.OFF: 0>, begin_time=0.0, end_time=0.0, under_pressure_for_strips_and_columns=35.0, under_pressure_for_sand_wall=35.0, start_of_drainage=0.0, phreatic_level_in_drain=0.0, water_head_during_dewatering=0.0, tube_pressure_during_dewatering=0.0, time=[], underpressure=[], water_level=[]), probabilistic_data=ProbabilisticData(reliability_x_co__ordinate=0.0, residual_settlement=1.0, maximum_drawings=100, maximum_iterations=15, reliability_type=<InternalProbabilisticCalculationType.FOSMOrDeterministic: 0>, is_reliability_calculation=<Bool.FALSE: 0>), probabilistic_defaults='ProbDefGamDryVar=0.05\nProbDefGamWetVar=0.05\nProbDefPOPVar=0.25\nProbDefOCRVar=0.25\nProbDefPcVar=0.25\nProbDefPermeabilityVerVar=2.50\nProbDefRatioHorVerPermeabilityCvVar=0.25\nProbDefCvVar=0.50\nProbDefCpVar=0.30\nProbDefCp1Var=0.30\nProbDefCsVar=0.30\nProbDefCs1Var=0.30\nProbDefApVar=0.30\nProbDefASecVar=0.30\nProbDefRRCrVar=0.25\nProbDefCRCcVar=0.25\nProbDefCaVar=0.25\nProbDefPriCompIndexVar=0.25\nProbDefSecCompIndexVar=0.25\nProbDefSecCompRateVar=0.25\nProbDefCpCor=0.01\nProbDefCsCor=0.01\nProbDefCs1Cor=0.01\nProbDefApCor=0.01\nProbDefASecCor=0.01\nProbDefRRCrCor=0.01\nProbDefCaCor=0.01\nProbDefPriCompIndexCor=0.01\nProbDefSecCompRateCor=0.01\nProbDefGamDryDist=2\nProbDefGamWetDist=2\nProbDefPOPDist=2\nProbDefOCRDist=2\nProbDefPcDist=2\nProbDefPermeabilityVerDist=2\nProbDefRatioHorVerPermeabilityCvDist=2\nProbDefCvDist=2\nProbDefCpDist=2\nProbDefCp1Dist=2\nProbDefCsDist=2\nProbDefCs1Dist=2\nProbDefApDist=2\nProbDefASecDist=2\nProbDefRRCrDist=2\nProbDefCRCcDist=2\nProbDefCaDist=2\nProbDefPriCompIndexDist=2\nProbDefSecCompIndexDist=2\nProbDefSecCompRateDist=2\nProbDefLayerStd=0.10\nProbDefLayerDist=0', fit_options=FitOptions(fit_maximum_number_of_iterations=5, fit_required_iteration_accuracy=0.0001, fit_required_correlation_coefficient=0.99), fit_calculation=FitCalculation(is_fit_calculation=<Bool.FALSE: 0>, fit_vertical_number=0), fit=' 0 = number of items')), 'output_data': FieldInfo(annotation=Union[Results, 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.
-
input_data:
- class geolib.models.dsettlement.internal.Depths(*args, depths: List[float])¶
-
depths:
List
[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]] = {'depths': FieldInfo(annotation=List[float], required=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.
-
depths:
- class geolib.models.dsettlement.internal.Dimension(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- ONE_D = 0¶
- TWO_D = 1¶
- class geolib.models.dsettlement.internal.DispersionConditionLayerBoundary(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- DRAINED = 1¶
- UNDRAINED = 0¶
- class geolib.models.dsettlement.internal.DispersionConditionsLayerBoundaries(*args, dispersion_conditions_layer_boundaries_top: DispersionConditionLayerBoundary = DispersionConditionLayerBoundary.DRAINED, dispersion_conditions_layer_boundaries_bottom: DispersionConditionLayerBoundary = DispersionConditionLayerBoundary.DRAINED)¶
-
dispersion_conditions_layer_boundaries_bottom:
DispersionConditionLayerBoundary
¶
-
dispersion_conditions_layer_boundaries_top:
DispersionConditionLayerBoundary
¶
- 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]] = {'dispersion_conditions_layer_boundaries_bottom': FieldInfo(annotation=DispersionConditionLayerBoundary, required=False, default=<DispersionConditionLayerBoundary.DRAINED: 1>), 'dispersion_conditions_layer_boundaries_top': FieldInfo(annotation=DispersionConditionLayerBoundary, required=False, default=<DispersionConditionLayerBoundary.DRAINED: 1>)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
dispersion_conditions_layer_boundaries_bottom:
- class geolib.models.dsettlement.internal.DistributionBoundaries(*args, distributionboundaries: List[DistributionType] = [])¶
- append_distribution_boundary(distribution_boundary)¶
- Parameters:
distribution_boundary (
DistributionType
)
-
distributionboundaries:
List
[DistributionType
]¶
- 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]] = {'distributionboundaries': FieldInfo(annotation=List[DistributionType], required=False, default=[])}¶
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.dsettlement.internal.DrainedLayers(*args, drainedlayers: List[int])¶
-
drainedlayers:
List
[int
]¶
- 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]] = {'drainedlayers': FieldInfo(annotation=List[int], required=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.
-
drainedlayers:
- class geolib.models.dsettlement.internal.FitCalculation(*args, is_fit_calculation: Bool = Bool.FALSE, fit_vertical_number: Annotated[int, Ge(ge=-1), Le(le=1000)] = 0)¶
-
fit_vertical_number:
Annotated
[int
]¶
- 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]] = {'fit_vertical_number': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=-1), Le(le=1000)]), 'is_fit_calculation': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 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.
-
fit_vertical_number:
- class geolib.models.dsettlement.internal.FitOptions(*args, fit_maximum_number_of_iterations: Annotated[int, Ge(ge=0), Le(le=100)] = 5, fit_required_iteration_accuracy: Annotated[float, Ge(ge=0.0), Le(le=1.0)] = 0.0001, fit_required_correlation_coefficient: Annotated[float, Ge(ge=0.0), Le(le=1.0)] = 0.99)¶
-
fit_maximum_number_of_iterations:
Annotated
[int
]¶
-
fit_required_correlation_coefficient:
Annotated
[float
]¶
-
fit_required_iteration_accuracy:
Annotated
[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]] = {'fit_maximum_number_of_iterations': FieldInfo(annotation=int, required=False, default=5, metadata=[Ge(ge=0), Le(le=100)]), 'fit_required_correlation_coefficient': FieldInfo(annotation=float, required=False, default=0.99, metadata=[Ge(ge=0), Le(le=1)]), 'fit_required_iteration_accuracy': FieldInfo(annotation=float, required=False, default=0.0001, metadata=[Ge(ge=0), Le(le=1)])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
fit_maximum_number_of_iterations:
- class geolib.models.dsettlement.internal.GeometryData(*args, points: Points = Points(points=[]), curves: Curves = Curves(curves=[]), boundaries: Boundaries = Boundaries(boundaries=[]), use_probabilistic_defaults_boundaries: UseProbabilisticDefaultsBoundaries = UseProbabilisticDefaultsBoundaries(useprobabilisticdefaultsboundaries=[]), stdv_boundaries: StdvBoundaries = StdvBoundaries(stdvboundaries=[]), distribution_boundaries: DistributionBoundaries = DistributionBoundaries(distributionboundaries=[]), piezo_lines: PiezoLines = PiezoLines(piezolines=[]), phreatic_line: PhreaticLine = PhreaticLine(phreatic_line=0), layers: Layers = Layers(layers=[]))¶
Representation of [GEOMETRY DATA] group.
-
boundaries:
Boundaries
¶
- boundary_area_above_horizontal(boundary, y=0.0)¶
Area above horizontal line defined by y-coordinate.
- Parameters:
boundary (
Boundary
)y (
float
)
- Return type:
float
- create_list_of_indexes()¶
- Return type:
List
-
distribution_boundaries:
DistributionBoundaries
¶
- get_point(point_id)¶
- Parameters:
point_id (
int
)- Return type:
Optional
[DSeriePoint
]
- 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]] = {'boundaries': FieldInfo(annotation=Boundaries, required=False, default=Boundaries(boundaries=[])), 'curves': FieldInfo(annotation=Curves, required=False, default=Curves(curves=[])), 'distribution_boundaries': FieldInfo(annotation=DistributionBoundaries, required=False, default=DistributionBoundaries(distributionboundaries=[])), 'layers': FieldInfo(annotation=Layers, required=False, default=Layers(layers=[])), 'phreatic_line': FieldInfo(annotation=PhreaticLine, required=False, default=PhreaticLine(phreatic_line=0)), 'piezo_lines': FieldInfo(annotation=PiezoLines, required=False, default=PiezoLines(piezolines=[])), 'points': FieldInfo(annotation=Points, required=False, default=Points(points=[])), 'stdv_boundaries': FieldInfo(annotation=StdvBoundaries, required=False, default=StdvBoundaries(stdvboundaries=[])), 'use_probabilistic_defaults_boundaries': FieldInfo(annotation=UseProbabilisticDefaultsBoundaries, required=False, default=UseProbabilisticDefaultsBoundaries(useprobabilisticdefaultsboundaries=[]))}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
phreatic_line:
PhreaticLine
¶
-
piezo_lines:
PiezoLines
¶
- pre_process()¶
- sort_based_on_new_indexes(new_indexes, unsorted_list)¶
- Parameters:
new_indexes (
List
)unsorted_list (
List
)
- Return type:
List
- sort_boundaries()¶
- sort_probabilistic_list_based_on_new_indexes()¶
-
stdv_boundaries:
StdvBoundaries
¶
-
use_probabilistic_defaults_boundaries:
UseProbabilisticDefaultsBoundaries
¶
-
boundaries:
- class geolib.models.dsettlement.internal.HorizontalDisplacements(*args, horizontaldisplacements: List[List[float]])¶
-
horizontaldisplacements:
List
[List
[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]] = {'horizontaldisplacements': FieldInfo(annotation=List[List[float]], required=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.
-
horizontaldisplacements:
- class geolib.models.dsettlement.internal.InternalProbabilisticCalculationType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- BandWidthAndProbabilityOfFailureMonteCarlo = 2¶
- FOSMOrDeterministic = 0¶
- ProbabilityOfFailureFORM = 1¶
- class geolib.models.dsettlement.internal.KoppejanSettlements(*args, koppejansettlements: List[Dict[str, float]])¶
-
koppejansettlements:
List
[Dict
[str
,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]] = {'koppejansettlements': FieldInfo(annotation=List[Dict[str, float]], required=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.
-
koppejansettlements:
- class geolib.models.dsettlement.internal.Layer(*args, id: Annotated[int, Gt(gt=0)] = 1, material: str = '', piezo_top: Annotated[int, Ge(ge=0), Le(le=99)] = 0, piezo_bottom: Annotated[int, Ge(ge=0), Le(le=99)] = 0, boundary_top: int, boundary_bottom: int)¶
-
boundary_bottom:
int
¶
-
boundary_top:
int
¶
-
id:
Annotated
[int
]¶
-
material:
str
¶
- 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]] = {'boundary_bottom': FieldInfo(annotation=int, required=True), 'boundary_top': FieldInfo(annotation=int, required=True), 'id': FieldInfo(annotation=int, required=False, default=1, metadata=[Gt(gt=0)]), 'material': FieldInfo(annotation=str, required=False, default=''), 'piezo_bottom': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=0), Le(le=99)]), 'piezo_top': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=0), Le(le=99)])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
piezo_bottom:
Annotated
[int
]¶
-
piezo_top:
Annotated
[int
]¶
-
boundary_bottom:
- class geolib.models.dsettlement.internal.Layers(*args, layers: List[Layer] = [])¶
Representation of [LAYERS] group.
- 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]] = {'layers': FieldInfo(annotation=List[Layer], required=False, default=[])}¶
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.dsettlement.internal.Leakages(*args, leakages: List[float])¶
-
leakages:
List
[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]] = {'leakages': FieldInfo(annotation=List[float], required=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.
-
leakages:
- class geolib.models.dsettlement.internal.LoadValuesCircular(**data)¶
- Parameters:
data (
Any
)
-
R:
float
¶
-
Xcp:
float
¶
-
Ycp:
float
¶
-
Zcp:
float
¶
-
alpha:
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]] = {'R': FieldInfo(annotation=float, required=False, default=0.01), 'Xcp': FieldInfo(annotation=float, required=False, default=0), 'Ycp': FieldInfo(annotation=float, required=False, default=0), 'Zcp': FieldInfo(annotation=float, required=False, default=0), 'alpha': FieldInfo(annotation=float, required=False, default=0), 'weight': FieldInfo(annotation=float, required=False, default=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.
-
weight:
float
¶
- class geolib.models.dsettlement.internal.LoadValuesRectangular(**data)¶
- Parameters:
data (
Any
)
-
Xcp:
float
¶
-
Ycp:
float
¶
-
Zcp:
float
¶
-
alpha:
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]] = {'Xcp': FieldInfo(annotation=float, required=False, default=0), 'Ycp': FieldInfo(annotation=float, required=False, default=0), 'Zcp': FieldInfo(annotation=float, required=False, default=0), 'alpha': FieldInfo(annotation=float, required=False, default=0), 'weight': FieldInfo(annotation=float, required=False, default=0), 'xwidth': FieldInfo(annotation=float, required=False, default=0.01), 'zwidth': FieldInfo(annotation=float, required=False, default=0.01)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
weight:
float
¶
-
xwidth:
float
¶
-
zwidth:
float
¶
- class geolib.models.dsettlement.internal.LoadValuesTank(**data)¶
- Parameters:
data (
Any
)
-
Rintern:
float
¶
-
Xcp:
float
¶
-
Ycp:
float
¶
-
Zcp:
float
¶
-
alpha:
float
¶
-
dWall:
float
¶
-
internalweight:
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]] = {'Rintern': FieldInfo(annotation=float, required=False, default=0.01), 'Xcp': FieldInfo(annotation=float, required=False, default=0), 'Ycp': FieldInfo(annotation=float, required=False, default=0), 'Zcp': FieldInfo(annotation=float, required=False, default=0), 'alpha': FieldInfo(annotation=float, required=False, default=0), 'dWall': FieldInfo(annotation=float, required=False, default=0.01), 'internalweight': FieldInfo(annotation=float, required=False, default=0), 'wallweight': FieldInfo(annotation=float, required=False, default=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.
-
wallweight:
float
¶
- class geolib.models.dsettlement.internal.LoadValuesTrapeziform(**data)¶
- Parameters:
data (
Any
)
-
Xp:
float
¶
-
Yp:
float
¶
-
gamma:
float
¶
-
height:
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]] = {'Xp': FieldInfo(annotation=float, required=False, default=0), 'Yp': FieldInfo(annotation=float, required=False, default=0), 'gamma': FieldInfo(annotation=float, required=False, default=0), 'height': FieldInfo(annotation=float, required=False, default=0), 'xl': FieldInfo(annotation=float, required=False, default=0), 'xm': FieldInfo(annotation=float, required=False, default=0), 'xr': FieldInfo(annotation=float, required=False, default=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.
-
xl:
float
¶
-
xm:
float
¶
-
xr:
float
¶
- class geolib.models.dsettlement.internal.LoadValuesUniform(**data)¶
- Parameters:
data (
Any
)
-
gamma:
float
¶
-
height:
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]] = {'gamma': FieldInfo(annotation=float, required=False, default=0), 'height': FieldInfo(annotation=float, required=False, default=0), 'unit_weight': FieldInfo(annotation=float, required=False, default=0), 'y_application': FieldInfo(annotation=float, required=False, default=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.
-
unit_weight:
float
¶
-
y_application:
float
¶
- class geolib.models.dsettlement.internal.Model(*args, dimension: Dimension = Dimension.TWO_D, consolidation_model: ConsolidationModel = ConsolidationModel.DARCY, soil_model: SoilModel = SoilModel.NEN_KOPPEJAN, strain_type: StrainType = StrainType.LINEAR, is_vertical_drains: Bool = Bool.FALSE, is_fit_for_settlement_plate: Bool = Bool.FALSE, is_probabilistic: Bool = Bool.FALSE, is_horizontal_displacements: Bool = Bool.FALSE, is_secondary_swelling: Bool = Bool.FALSE)¶
-
consolidation_model:
ConsolidationModel
¶
- 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]] = {'consolidation_model': FieldInfo(annotation=ConsolidationModel, required=False, default=<ConsolidationModel.DARCY: 0>), 'dimension': FieldInfo(annotation=Dimension, required=False, default=<Dimension.TWO_D: 1>), 'is_fit_for_settlement_plate': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'is_horizontal_displacements': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'is_probabilistic': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'is_secondary_swelling': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'is_vertical_drains': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'soil_model': FieldInfo(annotation=SoilModel, required=False, default=<SoilModel.NEN_KOPPEJAN: 0>), 'strain_type': FieldInfo(annotation=StrainType, required=False, default=<StrainType.LINEAR: 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.
-
strain_type:
StrainType
¶
-
consolidation_model:
- class geolib.models.dsettlement.internal.NonUniformLoad(**data)¶
- Parameters:
data (
Any
)
-
endtime:
int
¶
-
gammadry:
float
¶
-
gammawet:
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]] = {'endtime': FieldInfo(annotation=int, required=False, default=0), 'gammadry': FieldInfo(annotation=float, required=False, default=10), 'gammawet': FieldInfo(annotation=float, required=False, default=10), 'points': FieldInfo(annotation=List[PointForLoad], required=True), 'temporary': FieldInfo(annotation=Bool, required=False, default=False), 'time': FieldInfo(annotation=int, required=False, default=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.
-
points:
List
[PointForLoad
]¶
-
time:
int
¶
- class geolib.models.dsettlement.internal.NonUniformLoads(*args, loads: Dict[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=25, pattern=None)], NonUniformLoad] = {})¶
Representation of [NON-UNIFORM LOADS] group.
- add_load(name, load)¶
- Parameters:
name (
str
)load (
NonUniformLoad
)
- Return type:
Optional
[ValueError
]
-
loads:
Dict
[Annotated
[str
],NonUniformLoad
]¶
- 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]] = {'loads': FieldInfo(annotation=Dict[Annotated[str, StringConstraints], NonUniformLoad], required=False, default={})}¶
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.dsettlement.internal.OtherLoad(**data)¶
- Parameters:
data (
Any
)
-
load_type:
TypeOtherLoads
¶
-
load_values_circular:
Optional
[LoadValuesCircular
]¶
-
load_values_rectangular:
Optional
[LoadValuesRectangular
]¶
-
load_values_tank:
Optional
[LoadValuesTank
]¶
-
load_values_trapeziform:
Optional
[LoadValuesTrapeziform
]¶
-
load_values_uniform:
Optional
[LoadValuesUniform
]¶
- 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]] = {'load_type': FieldInfo(annotation=TypeOtherLoads, required=True), 'load_values_circular': FieldInfo(annotation=Union[LoadValuesCircular, NoneType], required=False, default=None), 'load_values_rectangular': FieldInfo(annotation=Union[LoadValuesRectangular, NoneType], required=False, default=None), 'load_values_tank': FieldInfo(annotation=Union[LoadValuesTank, NoneType], required=False, default=None), 'load_values_trapeziform': FieldInfo(annotation=Union[LoadValuesTrapeziform, NoneType], required=False, default=None), 'load_values_uniform': FieldInfo(annotation=Union[LoadValuesUniform, NoneType], required=False, default=None), 'time': FieldInfo(annotation=int, required=False, default=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.
-
time:
int
¶
- class geolib.models.dsettlement.internal.OtherLoads(*args, loads: Dict[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=25, pattern=None)], OtherLoad] = {})¶
Representation of [OTHER LOADS] group.
- 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]] = {'loads': FieldInfo(annotation=Dict[Annotated[str, StringConstraints], OtherLoad], required=False, default={})}¶
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.dsettlement.internal.PhreaticLine(*args, phreatic_line: Annotated[int, Ge(ge=0), Lt(lt=99)] = 0)¶
- 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]] = {'phreatic_line': FieldInfo(annotation=int, required=False, default=0, metadata=[Ge(ge=0), Lt(lt=99)])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
phreatic_line:
Annotated
[int
]¶
- class geolib.models.dsettlement.internal.PiezoLine(*args, id: Annotated[int, Gt(gt=0)] = 1, curves: List[int] = [])¶
-
curves:
List
[int
]¶
-
id:
Annotated
[int
]¶
- 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]] = {'curves': FieldInfo(annotation=List[int], required=False, default=[]), 'id': FieldInfo(annotation=int, required=False, default=1, metadata=[Gt(gt=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.
-
curves:
- class geolib.models.dsettlement.internal.PiezoLines(*args, piezolines: List[PiezoLine] = [])¶
Representation of [PIEZO LINES] group.
- 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]] = {'piezolines': FieldInfo(annotation=List[PiezoLine], required=False, default=[])}¶
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.dsettlement.internal.PointForLoad(**data)¶
Different from DSeriePoint as it does not belong in [POINTS].
- Parameters:
data (
Any
)
-
X:
float
¶
-
Y:
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]] = {'X': FieldInfo(annotation=float, required=True), 'Y': FieldInfo(annotation=float, required=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.
- class geolib.models.dsettlement.internal.Points(*args, points: List[DSeriePoint] = [])¶
Representation of [POINTS] group.
- add_point(point)¶
- Parameters:
point (
DSeriePoint
)- Return type:
- add_point_if_unique(point, tolerance=1e-10)¶
- Parameters:
point (
DSeriePoint
)- Return type:
- 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]] = {'points': FieldInfo(annotation=List[DSeriePoint], required=False, default=[])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
points:
List
[DSeriePoint
]¶
- class geolib.models.dsettlement.internal.PreconPressureWithinLayer(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- CONSTANT_CORRECTION_ALL_T = 2¶
- CONSTANT_CORRECTION_T0 = 1¶
- CONSTANT_NO_CORRECTION = 0¶
- VARIABLE_CORRECTION_ALL_T = 5¶
- VARIABLE_CORRECTION_T0 = 4¶
- VARIABLE_NO_CORRECTION = 3¶
- class geolib.models.dsettlement.internal.ProbabilisticData(*args, reliability_x_co__ordinate: float = 0, residual_settlement: Annotated[float, Ge(ge=0.0), Le(le=1000.0)] = 1, maximum_drawings: Annotated[int, Ge(ge=0), Le(le=999999999)] = 100, maximum_iterations: Annotated[int, Ge(ge=1), Le(le=50)] = 15, reliability_type: InternalProbabilisticCalculationType = InternalProbabilisticCalculationType.FOSMOrDeterministic, is_reliability_calculation: Bool = Bool.FALSE)¶
- externaltointernalprobabilisticcalculationtype(reliability_type)¶
- Parameters:
reliability_type (
ProbabilisticCalculationType
)- Return type:
-
maximum_drawings:
Annotated
[int
]¶
-
maximum_iterations:
Annotated
[int
]¶
- 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]] = {'is_reliability_calculation': FieldInfo(annotation=Bool, required=False, default=<Bool.FALSE: 0>), 'maximum_drawings': FieldInfo(annotation=int, required=False, default=100, metadata=[Ge(ge=0), Le(le=999999999)]), 'maximum_iterations': FieldInfo(annotation=int, required=False, default=15, metadata=[Ge(ge=1), Le(le=50)]), 'reliability_type': FieldInfo(annotation=InternalProbabilisticCalculationType, required=False, default=<InternalProbabilisticCalculationType.FOSMOrDeterministic: 0>), 'reliability_x_co__ordinate': FieldInfo(annotation=float, required=False, default=0), 'residual_settlement': FieldInfo(annotation=float, required=False, default=1, metadata=[Ge(ge=0), Le(le=1000)])}¶
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_type:
InternalProbabilisticCalculationType
¶
-
reliability_x_co__ordinate:
float
¶
-
residual_settlement:
Annotated
[float
]¶
- set_probabilistic_data(point_of_vertical, residual_settlement, maximum_number_of_samples, maximum_iterations, reliability_type, is_reliability_calculation)¶
- Parameters:
point_of_vertical (
Point
)residual_settlement (
float
)maximum_number_of_samples (
int
)maximum_iterations (
int
)reliability_type (
ProbabilisticCalculationType
)is_reliability_calculation (
bool
)
- class geolib.models.dsettlement.internal.ResidualSettlements(*args, residualsettlements: List[Dict[str, 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]] = {'residualsettlements': FieldInfo(annotation=List[Dict[str, float]], required=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.
-
residualsettlements:
List
[Dict
[str
,float
]]¶
- class geolib.models.dsettlement.internal.ResidualTimes(*args, time_steps: List[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0)])]] = [])¶
Representation of [RESIDUAL TIMES] group.
- 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]] = {'time_steps': FieldInfo(annotation=List[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0)])]], required=False, default=[])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
time_steps:
List
[Annotated
[int
]]¶
- class geolib.models.dsettlement.internal.Results(*args, calculation_settings: CalculationSettings | None = None, verticals_count: int, vertical: List[Vertical], residual_settlements: List[ResidualSettlements], amounts_of_loads: str | None = None, dissipation_in_layers: str | None = None, reliability_calculation_results: str | None = None)¶
Representation of [results] group in sld file.
-
amounts_of_loads:
Optional
[str
]¶
-
calculation_settings:
Optional
[CalculationSettings
]¶
-
dissipation_in_layers:
Optional
[str
]¶
- 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]] = {'amounts_of_loads': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'calculation_settings': FieldInfo(annotation=Union[CalculationSettings, NoneType], required=False, default=None), 'dissipation_in_layers': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'reliability_calculation_results': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'residual_settlements': FieldInfo(annotation=List[ResidualSettlements], required=True), 'vertical': FieldInfo(annotation=List[Vertical], required=True), 'verticals_count': FieldInfo(annotation=int, required=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.
-
reliability_calculation_results:
Optional
[str
]¶
-
residual_settlements:
List
[ResidualSettlements
]¶
-
verticals_count:
int
¶
-
amounts_of_loads:
- class geolib.models.dsettlement.internal.SoilCollection(*args, soil: List[SoilInternal] = [])¶
- add_soil_if_unique(soil, tolerance=1e-10)¶
- Return type:
None
- 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]] = {'soil': FieldInfo(annotation=List[SoilInternal], required=False, default=[])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
soil:
List
[SoilInternal
]¶
- class geolib.models.dsettlement.internal.SoilModel(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- ISOTACHE = 2¶
- NEN_BJERRUM = 1¶
- NEN_KOPPEJAN = 0¶
- class geolib.models.dsettlement.internal.StdvBoundaries(*args, stdvboundaries: List[float] = [])¶
- append_stdv_boundary(stdv_boundary)¶
- Parameters:
stdv_boundary (
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]] = {'stdvboundaries': FieldInfo(annotation=List[float], required=False, default=[])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
stdvboundaries:
List
[float
]¶
- class geolib.models.dsettlement.internal.StrainType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- LINEAR = 0¶
- NATURAL = 1¶
- class geolib.models.dsettlement.internal.StressDistributionLoads(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- NONE = 0¶
- SIMULATE = 1¶
- class geolib.models.dsettlement.internal.StressDistributionSoil(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- BOUSSINESQ = 1¶
- BUISMAN = 0¶
- class geolib.models.dsettlement.internal.Stresses(*args, stresses: List[Dict[str, 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]] = {'stresses': FieldInfo(annotation=List[Dict[str, float]], required=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.
-
stresses:
List
[Dict
[str
,float
]]¶
- class geolib.models.dsettlement.internal.TimeDependentData(*args, timedependentdata: Dict[float, List[Dict[str, 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]] = {'timedependentdata': FieldInfo(annotation=Dict[float, List[Dict[str, float]]], required=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.
-
timedependentdata:
Dict
[float
,List
[Dict
[str
,float
]]]¶
- class geolib.models.dsettlement.internal.TimeSettlementPerLoad(*args, timesettlementperload: List[List[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]] = {'timesettlementperload': FieldInfo(annotation=List[List[float]], required=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.
-
timesettlementperload:
List
[List
[float
]]¶
- class geolib.models.dsettlement.internal.TypeOtherLoads(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
- Circular = 1¶
- Rectangular = 2¶
- Tank = 4¶
- Trapeziform = 0¶
- Uniform = 3¶
- class geolib.models.dsettlement.internal.UseProbabilisticDefaultsBoundaries(*args, useprobabilisticdefaultsboundaries: List[Bool] = [])¶
- append_use_probabilistic_defaults_boundary(use_probabilistic_boundary)¶
- Parameters:
use_probabilistic_boundary (
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]] = {'useprobabilisticdefaultsboundaries': FieldInfo(annotation=List[Bool], required=False, default=[])}¶
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.dsettlement.internal.Version(*args, soil: int = 1011, geometry: int = 1002, d__settlement: int = 1011)¶
-
d__settlement:
int
¶
-
geometry:
int
¶
- 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]] = {'d__settlement': FieldInfo(annotation=int, required=False, default=1011), 'geometry': FieldInfo(annotation=int, required=False, default=1002), 'soil': FieldInfo(annotation=int, required=False, default=1011)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
soil:
int
¶
-
d__settlement:
- class geolib.models.dsettlement.internal.Vertical(*args, id: int, x: float, z: float, time__settlement_per_load: TimeSettlementPerLoad | None = None, depths: Depths, leakages: Leakages | None = None, drained_layers: DrainedLayers | None = None, stresses: Stresses | None = None, koppejan_settlement: KoppejanSettlements | None = None, time__dependent_data: List[TimeDependentData], elasticity: float | None = None, horizontal_displacements: HorizontalDisplacements | None = None)¶
Representation of [Vertical] group in sld file.
-
drained_layers:
Optional
[DrainedLayers
]¶
-
elasticity:
Optional
[float
]¶
-
horizontal_displacements:
Optional
[HorizontalDisplacements
]¶
-
id:
int
¶
-
koppejan_settlement:
Optional
[KoppejanSettlements
]¶
- 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]] = {'depths': FieldInfo(annotation=Depths, required=True), 'drained_layers': FieldInfo(annotation=Union[DrainedLayers, NoneType], required=False, default=None), 'elasticity': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'horizontal_displacements': FieldInfo(annotation=Union[HorizontalDisplacements, NoneType], required=False, default=None), 'id': FieldInfo(annotation=int, required=True), 'koppejan_settlement': FieldInfo(annotation=Union[KoppejanSettlements, NoneType], required=False, default=None), 'leakages': FieldInfo(annotation=Union[Leakages, NoneType], required=False, default=None), 'stresses': FieldInfo(annotation=Union[Stresses, NoneType], required=False, default=None), 'time__dependent_data': FieldInfo(annotation=List[TimeDependentData], required=True), 'time__settlement_per_load': FieldInfo(annotation=Union[TimeSettlementPerLoad, NoneType], required=False, default=None), 'x': FieldInfo(annotation=float, required=True), 'z': FieldInfo(annotation=float, required=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.
-
time__dependent_data:
List
[TimeDependentData
]¶
-
time__settlement_per_load:
Optional
[TimeSettlementPerLoad
]¶
-
x:
float
¶
-
z:
float
¶
-
drained_layers:
- class geolib.models.dsettlement.internal.VerticalDrain(*args, drain_type: DrainType = DrainType.STRIP, range_from: Annotated[float, Ge(ge=-10000000.0), Le(le=10000000.0)] = 0, range_to: Annotated[float, Ge(ge=-10000000.0), Le(le=10000000.0)] = 0, bottom_position: Annotated[float, Ge(ge=-10000000.0), Le(le=10000000.0)] = 0, center_to_center: Annotated[float, Ge(ge=0.001), Le(le=1000)] = 3, width: Annotated[float, Ge(ge=0.001), Le(le=1000)] = 0.1, diameter: Annotated[float, Ge(ge=0.001), Le(le=1000)] = 0.1, thickness: Annotated[float, Ge(ge=0.001), Le(le=1000)] = 0.003, grid: DrainGridType = DrainGridType.UNDERDETERMINED, schedule_type: DrainSchedule = DrainSchedule.OFF, begin_time: Annotated[float, Ge(ge=0), Le(le=100000)] = 0, end_time: Annotated[float, Ge(ge=0), Le(le=100000)] = 0, under_pressure_for_strips_and_columns: Annotated[float, Ge(ge=0), Le(le=100000)] = 35, under_pressure_for_sand_wall: Annotated[float, Ge(ge=0), Le(le=100000)] = 35, start_of_drainage: Annotated[float, Ge(ge=0), Le(le=100000)] = 0, phreatic_level_in_drain: Annotated[float, Ge(ge=-10000000.0), Le(le=10000000.0)] = 0, water_head_during_dewatering: Annotated[float, Ge(ge=-10000000.0), Le(le=10000000.0)] = 0, tube_pressure_during_dewatering: Annotated[float, Ge(ge=-10000000.0), Le(le=10000000.0)] = 0, time: List[Annotated[float, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=100000)])]] = [], underpressure: List[Annotated[float, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=100000)])]] = [], water_level: List[Annotated[float, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=-10000000.0), Le(le=10000000.0)])]] = [])¶
-
begin_time:
Annotated
[float
]¶
-
bottom_position:
Annotated
[float
]¶
-
center_to_center:
Annotated
[float
]¶
-
diameter:
Annotated
[float
]¶
-
end_time:
Annotated
[float
]¶
-
grid:
DrainGridType
¶
- 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]] = {'begin_time': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=0), Le(le=100000)]), 'bottom_position': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=-10000000.0), Le(le=10000000.0)]), 'center_to_center': FieldInfo(annotation=float, required=False, default=3, metadata=[Ge(ge=0.001), Le(le=1000)]), 'diameter': FieldInfo(annotation=float, required=False, default=0.1, metadata=[Ge(ge=0.001), Le(le=1000)]), 'drain_type': FieldInfo(annotation=DrainType, required=False, default=<DrainType.STRIP: 0>), 'end_time': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=0), Le(le=100000)]), 'grid': FieldInfo(annotation=DrainGridType, required=False, default=<DrainGridType.UNDERDETERMINED: 2>), 'phreatic_level_in_drain': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=-10000000.0), Le(le=10000000.0)]), 'range_from': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=-10000000.0), Le(le=10000000.0)]), 'range_to': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=-10000000.0), Le(le=10000000.0)]), 'schedule_type': FieldInfo(annotation=DrainSchedule, required=False, default=<DrainSchedule.OFF: 0>), 'start_of_drainage': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=0), Le(le=100000)]), 'thickness': FieldInfo(annotation=float, required=False, default=0.003, metadata=[Ge(ge=0.001), Le(le=1000)]), 'time': FieldInfo(annotation=List[Annotated[float, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=100000)])]], required=False, default=[]), 'tube_pressure_during_dewatering': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=-10000000.0), Le(le=10000000.0)]), 'under_pressure_for_sand_wall': FieldInfo(annotation=float, required=False, default=35, metadata=[Ge(ge=0), Le(le=100000)]), 'under_pressure_for_strips_and_columns': FieldInfo(annotation=float, required=False, default=35, metadata=[Ge(ge=0), Le(le=100000)]), 'underpressure': FieldInfo(annotation=List[Annotated[float, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=100000)])]], required=False, default=[]), 'water_head_during_dewatering': FieldInfo(annotation=float, required=False, default=0, metadata=[Ge(ge=-10000000.0), Le(le=10000000.0)]), 'water_level': FieldInfo(annotation=List[Annotated[float, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=-10000000.0), Le(le=10000000.0)])]], required=False, default=[]), 'width': FieldInfo(annotation=float, required=False, default=0.1, metadata=[Ge(ge=0.001), Le(le=1000)])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
phreatic_level_in_drain:
Annotated
[float
]¶
-
range_from:
Annotated
[float
]¶
-
range_to:
Annotated
[float
]¶
-
schedule_type:
DrainSchedule
¶
-
start_of_drainage:
Annotated
[float
]¶
-
thickness:
Annotated
[float
]¶
-
time:
List
[Annotated
[float
]]¶
-
tube_pressure_during_dewatering:
Annotated
[float
]¶
-
under_pressure_for_sand_wall:
Annotated
[float
]¶
-
under_pressure_for_strips_and_columns:
Annotated
[float
]¶
-
underpressure:
List
[Annotated
[float
]]¶
-
water_head_during_dewatering:
Annotated
[float
]¶
-
water_level:
List
[Annotated
[float
]]¶
-
width:
Annotated
[float
]¶
-
begin_time:
- class geolib.models.dsettlement.internal.Verticals(*args, locations: List[DSeriePoint] = [])¶
Representation of [VERTICALS] group.
-
locations:
List
[DSeriePoint
]¶
- 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]] = {'locations': FieldInfo(annotation=List[DSeriePoint], required=False, default=[])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
-
locations:
- class geolib.models.dsettlement.internal.WaterLoad(**data)¶
- Parameters:
data (
Any
)
-
headlines:
List
[List
[int
]]¶
- 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]] = {'headlines': FieldInfo(annotation=List[List[int]], required=False, default=[[]]), 'name': FieldInfo(annotation=str, required=False, default=''), 'phreatic_line': FieldInfo(annotation=int, required=False, default=1), 'time': FieldInfo(annotation=int, required=False, default=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.
-
name:
str
¶
-
phreatic_line:
int
¶
-
time:
int
¶
- class geolib.models.dsettlement.internal.WaterLoads(*args, waterloads: List[WaterLoad] = [])¶
Representation of [WATER LOADS] group.
- add_waterload(name, time, phreatic_line, headlines)¶
- Parameters:
name (
str
)time (
int
)phreatic_line (
int
)headlines (
List
[List
[int
]])
- 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]] = {'waterloads': FieldInfo(annotation=List[WaterLoad], required=False, default=[])}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.