Skip to content

Index

subsurfaceio.footing_foundation_average_parameters

Footing / shallow foundation average parameters API.

Average soil parameters over a footing influence zone:

from subsurfaceio.footing_foundation_average_parameters import (
    FootingFoundationAverageParameters,
)

FootingFoundationAverageParameters(metadata=metadata, data=profile).calculate()

Classes:

Name Description
FootingAverageParametersResults

Averaged footing soil-parameter results.
FootingFoundationAverageParameters

Average soil parameters over footing influence depth.
FootingFoundationAverageParametersMetadata

Footing geometry for average-parameter calculation.
SoilProfileItem

Soil profile row for footing averaging.

Attributes:

Name Type Description
FootingAverageParametersResultsMetadata

FootingAverageParametersResultsMetadata module-attribute 

FootingAverageParametersResultsMetadata = create_model(
    "FootingAverageParametersResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.FootingAverageParameters.return_names(
            scalar=True
        )
    )
)

FootingAverageParametersResults pydantic-model

Bases: BaseModel

Averaged footing soil-parameter results.

Fields:

metadata pydantic-field 

metadata: FootingAverageParametersResultsMetadata

FootingFoundationAverageParameters pydantic-model

Bases: Model

Average soil parameters over footing influence depth.

References
  • bowles1996foundation

Fields:

data pydantic-field 

data: list[SoilProfileItem]

function_sequence class-attribute 

function_sequence: FunctionSequence = (
    FunctionSequences.FootingAverageParameters
)

metadata pydantic-field 

metadata: FootingFoundationAverageParametersMetadata

results pydantic-field 

results: FootingAverageParametersResults | None = None

calculate 

calculate() -> Self

Run the calculation and store results.

Returns:

Type Description
Self

self with results populated.

FootingFoundationAverageParametersMetadata pydantic-model

Bases: BaseModel

Footing geometry for average-parameter calculation.

Fields:

footing_embedment pydantic-field 

footing_embedment: float

footing_width pydantic-field 

footing_width: float

SoilProfileItem pydantic-model

Bases: BaseModel

Soil profile row for footing averaging.

Fields:

depth pydantic-field 

depth: float

friction_angle pydantic-field 

friction_angle: float

undrained_shear_strength pydantic-field 

undrained_shear_strength: float