geolib.models.dsettlement.drains

Classes

ScheduleValues(**data)	ScheduleValues to inherit from
ScheduleValuesDetailedInput(**data)	Drainage Schedule with strips or columns: Detailed Input
ScheduleValuesOff(**data)	Drainage Schedule with strips or columns is Off
ScheduleValuesSimpleInput(**data)	Drainage Schedule with strips or columns: Simple Input
VerticalDrain(**data)	Vertical Drain Class to inherit from.

class geolib.models.dsettlement.drains.ScheduleValues(**data)

ScheduleValues to inherit from

Parameters:

data (Any)

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]] = {'schedule': FieldInfo(annotation=Union[DrainSchedule, 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.

schedule: Optional[DrainSchedule]

class geolib.models.dsettlement.drains.ScheduleValuesDetailedInput(**data)

Drainage Schedule with strips or columns: Detailed Input

Parameters:

• active. (Time -- The time at which dewatering is)

• underpressure. (Underpressure -- This value is zero for vertical drains without enforced)

• dewatering. (Water head -- The vertical level where the negative pore pressure equals the enforced underpressure during)

• data (Any)

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]] = {'schedule': FieldInfo(annotation=Union[DrainSchedule, NoneType], required=False, default=None), 'time': FieldInfo(annotation=List[timedelta], required=False, default=[]), 'underpressure': FieldInfo(annotation=List[float], required=False, default=[]), 'water_level': 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.

time: List[timedelta]

underpressure: List[float]

water_level: List[float]

class geolib.models.dsettlement.drains.ScheduleValuesOff(**data)

Drainage Schedule with strips or columns is Off

Parameters:

• assumes (Start of drainage -- The time t at which the drain becomes active. D-SETTLEMENT) – that the water head in the drain equals the phreatic level.

• drainage. (Phreatic level in drain -- The water head in the drain during)

• data (Any)

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_level_in_drain': FieldInfo(annotation=float, required=True), 'schedule': FieldInfo(annotation=Union[DrainSchedule, NoneType], required=False, default=None), 'start_of_drainage': FieldInfo(annotation=timedelta, 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.

phreatic_level_in_drain: float

start_of_drainage: timedelta

class geolib.models.dsettlement.drains.ScheduleValuesSimpleInput(**data)

Drainage Schedule with strips or columns: Simple Input

Parameters:

• assumes (Start of drainage -- The time t at which the drain becomes active. D-SETTLEMENT) – that the water head in the drain equals the phreatic level.

• dewatering (Begin time -- The time at which)

• stops. (End time -- The time at which dewatering)

• dewatering. (Water head during dewatering -- The vertical level where the negative pore pressure equals the enforced underpressure during)

• dewatering.

• drainage. (Phreatic level in drain -- The water head in the drain during)

• data (Any)

begin_time: float

end_time: 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]] = {'begin_time': FieldInfo(annotation=float, required=True), 'end_time': FieldInfo(annotation=float, required=True), 'phreatic_level_in_drain': FieldInfo(annotation=float, required=True), 'schedule': FieldInfo(annotation=Union[DrainSchedule, NoneType], required=False, default=None), 'start_of_drainage': FieldInfo(annotation=timedelta, required=True), 'tube_pressure_during_dewatering': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'underpressure': FieldInfo(annotation=float, required=True), 'water_head_during_dewatering': FieldInfo(annotation=Union[float, 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.

phreatic_level_in_drain: float

start_of_drainage: timedelta

tube_pressure_during_dewatering: Optional[float]

underpressure: float

water_head_during_dewatering: Optional[float]

class geolib.models.dsettlement.drains.VerticalDrain(**data)

Vertical Drain Class to inherit from. This class refers to the input window “Vertical Drains” of the D-Settlement program.

Parameters:

• area (range_to -- right limit to the drained)

• area

• The (bottom_position --)

• drains. (center_to_center -- The actual spacing between the)

• drain. (thickness -- The actual thickness of the Strip)

• drain.

• grid. (grid -- The geometry of the)

• data (Any)

bottom_position: float

center_to_center: float

diameter: Optional[float]

drain_type: DrainType

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]] = {'bottom_position': FieldInfo(annotation=float, required=True), 'center_to_center': FieldInfo(annotation=float, required=True), 'diameter': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'drain_type': FieldInfo(annotation=DrainType, required=False, default=<DrainType.STRIP: 0>), 'grid': FieldInfo(annotation=DrainGridType, required=False, default=<DrainGridType.UNDERDETERMINED: 2>), 'range_from': FieldInfo(annotation=float, required=True), 'range_to': FieldInfo(annotation=float, required=True), 'schedule': FieldInfo(annotation=ScheduleValues, required=False, default=None), 'thickness': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'width': FieldInfo(annotation=Union[float, 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.

range_from: float

range_to: float

schedule: ScheduleValues

thickness: Optional[float]

width: Optional[float]