geolib.models.dsheetpiling.surface

Classes

Surface(**data)

Surface.
class geolib.models.dsheetpiling.surface.Surface(**data)

Surface.

Parameters:

  • name – Name of the surface.

  • points – Surface points. Points (X, Z) must be defined from the sheet outwards regarding x-coordinate.

  • distribution_type – Distribution type.

  • std – Standard deviation of the distribution type.

  • data (Any)

distribution_type: Optional[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]] = {'distribution_type': FieldInfo(annotation=Union[DistributionType, NoneType], required=False, default=None), 'name': FieldInfo(annotation=str, required=True, metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=50, pattern=None)]), 'points': FieldInfo(annotation=List[Point], required=True, metadata=[MinLen(min_length=1)]), 'std': FieldInfo(annotation=Union[Annotated[float, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0.0)])], 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.

name: Annotated[str]
points: Annotated[List[Point]]
classmethod points_must_be_increasing_and_greater_or_equal_to_zero(v)
classmethod points_validator(v)
std: Optional[Annotated[float]]