Skip to content

Index

subsurfaceio.pile_foundation_settlement

Pile foundation settlement API.

Compute pile settlement for a bearing or floating pile:

from subsurfaceio.pile_foundation_settlement import PileFoundationSettlement

PileFoundationSettlement(model=bearing_pile_inputs).calculate()

Classes:

Name Description
PileFoundationSettlement

Pile foundation settlement (bearing or floating).
PileSettlementsBearingPilePoulos1980

Poulos bearing pile settlement method.
PileSettlementsBearingPilePoulos1980Results

Bearing pile settlement results.
PileSettlementsFloatingPilePoulos1980

Poulos floating pile settlement method.
PileSettlementsFloatingPilePoulos1980Results

Floating pile settlement results.
PileSettlementsMixin

Shared pile and soil inputs for settlement methods.

Attributes:

Name Type Description
PILE_SETTLEMENTS
PileSettlementsBearingPilePoulos1980ResultsMetadata
PileSettlementsFloatingPilePoulos1980ResultsMetadata

PILE_SETTLEMENTS module-attribute 

PILE_SETTLEMENTS = {
    "BearingPilePoulos1980": PileSettlementsBearingPilePoulos1980Results,
    "FloatingPilePoulos1980": PileSettlementsFloatingPilePoulos1980Results,
}

PileSettlementsBearingPilePoulos1980ResultsMetadata module-attribute 

PileSettlementsBearingPilePoulos1980ResultsMetadata = create_model(
    "PileSettlementsBearingPilePoulos1980ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.PileSettlementsBearingPilePoulos1980.return_names(
            scalar=True
        )
    )
)

PileSettlementsFloatingPilePoulos1980ResultsMetadata module-attribute 

PileSettlementsFloatingPilePoulos1980ResultsMetadata = create_model(
    "PileSettlementsFloatingPilePoulos1980ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.PileSettlementsFloatingPilePoulos1980.return_names(
            scalar=True
        )
    )
)

PileFoundationSettlement pydantic-model

Bases: Model

Pile foundation settlement (bearing or floating).

References
  • poulos1980pile

Fields:

model pydantic-field 

model: (
    PileSettlementsBearingPilePoulos1980
    | PileSettlementsFloatingPilePoulos1980
)

Pile settlement calculation method

results pydantic-field 

results: (
    PileSettlementsBearingPilePoulos1980Results
    | PileSettlementsFloatingPilePoulos1980Results
    | None
) = None

Calculation results

calculate 

calculate() -> Self

Run the calculation and store results.

Returns:

Type Description
Self

self with results populated.

plot_geometry 

plot_geometry() -> plotly.graph_objects.Figure

Build a 3-D geometry sketch of the pile and soil.

Returns:

Type Description
Figure

Plotly 3-D figure.

PileSettlementsBearingPilePoulos1980 pydantic-model

Bases: PileSettlementsMixin

Poulos bearing pile settlement method.

Fields:

elasticity_modulus_bearing_soil pydantic-field 

elasticity_modulus_bearing_soil: float

function_sequence class-attribute 

function_sequence: FunctionSequence = (
    FunctionSequences.PileSettlementsBearingPilePoulos1980
)

method pydantic-field 

method: Literal['BearingPilePoulos1980']

PileSettlementsBearingPilePoulos1980Results pydantic-model

Bases: BaseModel

Bearing pile settlement results.

Fields:

metadata pydantic-field 

metadata: (
    PileSettlementsBearingPilePoulos1980ResultsMetadata
)

method pydantic-field 

method: Literal['BearingPilePoulos1980']

PileSettlementsFloatingPilePoulos1980 pydantic-model

Bases: PileSettlementsMixin

Poulos floating pile settlement method.

Fields:

function_sequence class-attribute 

function_sequence: FunctionSequence = (
    FunctionSequences.PileSettlementsFloatingPilePoulos1980
)

method pydantic-field 

method: Literal['FloatingPilePoulos1980']

soil_thickness pydantic-field 

soil_thickness: float

PileSettlementsFloatingPilePoulos1980Results pydantic-model

Bases: BaseModel

Floating pile settlement results.

Fields:

metadata pydantic-field 

metadata: (
    PileSettlementsFloatingPilePoulos1980ResultsMetadata
)

method pydantic-field 

method: Literal['FloatingPilePoulos1980']

PileSettlementsMixin pydantic-model

Bases: BaseModel

Shared pile and soil inputs for settlement methods.

Fields:

elasticity_modulus pydantic-field 

elasticity_modulus: float

method pydantic-field 

method: str

pile_area_ratio pydantic-field 

pile_area_ratio: float

pile_diameter pydantic-field 

pile_diameter: float

pile_elasticity_modulus pydantic-field 

pile_elasticity_modulus: float

pile_embedment_length pydantic-field 

pile_embedment_length: float

pile_head_axial_load pydantic-field 

pile_head_axial_load: float

poisson_ratio pydantic-field 

poisson_ratio: float

plot_geometry 

plot_geometry() -> plotly.graph_objects.Figure

Build a 3-D geometry sketch of the pile and soil.

Returns:

Type Description
Figure

Plotly 3-D figure.