Skip to content

Index

subsurfaceio.function_sequences

Function sequence orchestration.

Chains callables from subsurfaceio.functions into ordered pipelines. Named recipes live on FunctionSequences; FunctionSequence builds a custom pipeline.

from subsurfaceio.function_sequences import FunctionSequences

results = FunctionSequences.FootingCapacityTerzaghi1943.calculate(inputs)

Classes:

Name Description
CalculationResults

Results from a FunctionSequence run.
FunctionSequence

Immutable ordered pipeline of subsurfaceio.functions callables.
FunctionSequences

Function sequence registry.

Attributes:

Name Type Description
OutputMode TypeAlias

calculate / run_sequence output mode: declared returns or full namespace.

OutputMode module-attribute 

OutputMode: TypeAlias = Literal['returns', 'all']

calculate / run_sequence output mode: declared returns or full namespace.

CalculationResults

Bases: dict

Results from a FunctionSequence run.

Methods:

Name Description
by_ndim

Group result values by numpy rank.
to_records

Split 0-d scalars into metadata and 1-d columns into data row dicts.

by_ndim 

by_ndim(
    *, as_python: bool = False
) -> dict[str, dict[str, Any]]

Group result values by numpy rank.

Parameters:

Name Type Description Default
as_python bool

Convert ndarrays to nested lists and 0-d ndarrays to Python scalars. Non-finite floats are left unchanged.

 False

Returns:

Type Description
dict[str, dict[str, Any]]

Mapping of rank labels ('0d', '1d', …) to name/value dicts.

to_records 

to_records(*, as_python: bool = False) -> dict[str, Any]

Split 0-d scalars into metadata and 1-d columns into data row dicts.

Parameters:

Name Type Description Default
as_python bool

Forwarded to by_ndim.

 False

Returns:

Type Description
dict[str, Any]

Mapping with optional metadata (scalars) and data (row dicts).

Raises:

Type Description
ValueError

If a result rank other than 0-d/1-d is present, or 1-d columns have unequal length.

FunctionSequence

Immutable ordered pipeline of subsurfaceio.functions callables.

Methods:

Name Description
calculate

Run this sequence against an input namespace.
return_names

Declared output names from this sequence, optionally by schema slot.

Attributes:

Name Type Description
functions tuple[SequenceFunction, ...]

Declared functions in pipeline order.

functions property 

functions: tuple[SequenceFunction, ...]

Declared functions in pipeline order.

calculate 

calculate(
    inputs: dict[str, Any],
    *,
    output: OutputMode = "returns",
    include: tuple[str, ...] = (),
    skip_provided: bool = True
) -> CalculationResults

Run this sequence against an input namespace.

Parameters:

Name Type Description Default
inputs dict[str, Any]

Named inputs for the pipeline.

 required
output OutputMode

'returns' for declared outputs only, or 'all' for the full working namespace.

 'returns'
include tuple[str, ...]

Extra keys to keep when output='returns'.

 ()
skip_provided bool

Skip a function when all of its return names are already present in inputs.

 True

Returns:

Type Description
CalculationResults

Named calculation outputs (numpy-native values).

return_names 

return_names(*, scalar: bool | None = None) -> list[str]

Declared output names from this sequence, optionally by schema slot.

Order follows the functions in the sequence, then each function's returns. Duplicate names are kept once (first occurrence).

Parameters:

Name Type Description Default
scalar bool | None

If True, only names from functions with scalar=True. If False, only names from functions with scalar=False. If None, every declared return name.

 None

Returns:

Type Description
list[str]

Unique output names in pipeline order.

FunctionSequences

Function sequence registry.

Methods:

Name Description
as_dict

Return all catalog sequences sorted by name.
get

Return a named sequence from this catalog.

Attributes:

Name Type Description
AtterbergLimits FunctionSequence

Atterberg limits calculation based on ASTM D4318.
CPTFootingCapacityRobertson FunctionSequence

Shallow footing ultimate bearing capacity from CPT data based on Robertson's CPT guide (2024).
CPTFootingSettlementsRobertson FunctionSequence

Shallow footing settlement from CPT data based on Robertson's CPT guide (2024).
CPTInterpretationRobertson FunctionSequence

Comprehensive CPT interpretation of soil behavior type and geotechnical parameters based on Robertson's CPT guide (2024).
CPTLiquefactionBoulanger2014 FunctionSequence

CPT-based liquefaction triggering and settlement analysis based on Boulanger and Idriss (2014).
CPTLiquefactionIdriss2008 FunctionSequence

CPT-based liquefaction triggering and settlement analysis based on Idriss and Boulanger (2008).
CPTLiquefactionRobertson FunctionSequence

CPT-based liquefaction triggering and settlement analysis based on Robertson's CPT guide (2024).
CPTLiquefactionSaye2021 FunctionSequence

CPT-based liquefaction triggering analysis based on Saye et al. (2021).
CPTPileBustamante1982 FunctionSequence

Pile capacity from CPT data based on the Bustamante and Gianeselli (1982) LCPC method.
CPTPileBustamante1982Fellenius FunctionSequence

Pile capacity from CPT data based on the Bustamante and Gianeselli (1982) LCPC method as simplified in the Canadian Foundation Engineering Manual (1992).
CPTPileEslami1997 FunctionSequence

Pile capacity from CPT data based on the Eslami and Fellenius (1997) method.
DMTFootingSettlementsRobertson FunctionSequence

Shallow footing settlement from flat dilatometer (DMT) data based on Marchetti (1981).
DMTInterpretationMarchetti FunctionSequence

Flat dilatometer (DMT) interpretation of soil parameters based on Marchetti (1981).
DMTLiquefactionMarchetti FunctionSequence

DMT-based liquefaction triggering and settlement analysis.
FootingAverageParameters FunctionSequence

Average soil parameters for footing design based on Bowles (1996).
FootingCapacityMeyerhof1978StrongSandOnSoftSaturatedClay FunctionSequence

Bearing capacity of a strong sand layer overlying soft saturated clay based on Meyerhof and Hanna (1978).
FootingCapacityMeyerhof1978StrongSandOnWeakSand FunctionSequence

Bearing capacity of a strong sand layer overlying weak sand based on Meyerhof and Hanna (1978).
FootingCapacityMeyerhof1978StrongSaturatedClayOnSoftSaturatedClay FunctionSequence

Bearing capacity of a strong saturated clay layer overlying soft saturated clay based on Meyerhof and Hanna (1978).
FootingCapacityTerzaghi1943 FunctionSequence

Shallow footing ultimate bearing capacity based on Terzaghi's (1943) bearing capacity theory.
FootingCapacityVesic1975 FunctionSequence

Shallow footing ultimate bearing capacity with shape and depth factors based on Vesic (1975).
HydrometerAnalysis FunctionSequence

Hydrometer analysis calculation based on ASTM D422.
LiquefactionFinesBray2006 FunctionSequence

Fine-grained soil liquefaction susceptibility screening based on Bray and Sancio (2006).
LiquefactionShearInducedBuildingSettlementBray2017 FunctionSequence

Shear-induced building settlement from liquefaction based on Bray and Macedo (2017).
LiquefactionSummary FunctionSequence

Liquefaction potential index, severity, and displacement/settlement summary.
LiquefactionYoud2002LateralDisplacement FunctionSequence

Lateral spread displacement estimation based on Youd et al. (2002).
LiquidLimit FunctionSequence

Liquid limit calculation based on ASTM D4318.
PileCapacityUSACE1991 FunctionSequence

Pile axial capacity based on USACE (1991) design procedures.
PileRockingStiffness FunctionSequence

Pile rocking and swaying stiffness for soil-structure interaction analysis.
PileSettlementsBearingPilePoulos1980 FunctionSequence

Settlement of an end-bearing pile based on Poulos and Davis (1980).
PileSettlementsFloatingPilePoulos1980 FunctionSequence

Settlement of a floating pile based on Poulos and Davis (1980).
PlasticLimit FunctionSequence

Plastic limit calculation based on ASTM D4318.
SPTInterpretation FunctionSequence

Comprehensive geotechnical parameter correlations derived from SPT blow counts.
SPTLiquefactionBoulanger2014 FunctionSequence

SPT-based liquefaction triggering and settlement analysis based on Boulanger and Idriss (2014).
SPTLiquefactionCetin2004 FunctionSequence

SPT-based liquefaction triggering and settlement analysis based on Cetin et al. (2004).
SPTLiquefactionCetin2018 FunctionSequence

SPT-based liquefaction triggering and settlement analysis based on Cetin et al. (2018).
SPTLiquefactionIdriss2008 FunctionSequence

SPT-based liquefaction triggering and settlement analysis based on Idriss and Boulanger (2008).
SPTUnitWeightCorrelation FunctionSequence

Unit weight correlation derived from corrected SPT blow counts.
SSIEffects FunctionSequence

Soil-structure interaction (SSI) significance screening based on NIST (2012).
SSIFootingStiffness FunctionSequence

Foundation stiffness and damping for a surface footing based on NIST (2012) soil-structure interaction procedures.
SSIFootingStiffnessIntensities FunctionSequence

Distributed footing stiffness and damping intensities based on NIST (2012) soil-structure interaction procedures.
SSIIntermediate FunctionSequence

Intermediate parameters for soil-structure interaction (SSI) analysis based on NIST (2012).
SSINodeData FunctionSequence

Node-level data preparation for soil-structure interaction (SSI) analysis based on NIST (2012).
SSIPileStiffness FunctionSequence

Pile foundation stiffness and damping based on NIST (2012) soil-structure interaction procedures.
SSIPileStiffnessInGroup FunctionSequence

Pile group stiffness and damping efficiency based on NIST (2012) soil-structure interaction procedures.
SieveAnalysis FunctionSequence

Sieve analysis calculation based on ASTM D421.
SieveAnalysisIndexProperties FunctionSequence

Gradation index properties (uniformity and curvature coefficients) from sieve analysis based on ASTM D421.
SieveAnalysisPercentFiner FunctionSequence

Percent finer calculation from sieve analysis mass-retained data based on ASTM D421.
SoilClassificationAASHTO FunctionSequence

Soil classification under the AASHTO system based on ASTM D3282.
SoilClassificationUSCS FunctionSequence

Soil classification under the Unified Soil Classification System (USCS) based on ASTM D2487.
SoilClassificationUSDA FunctionSequence

Soil textural classification based on the USDA soil classification system.
SoilClassificationUSDAMoreno2018 FunctionSequence

USDA soil textural classification with adjustments based on Moreno (2018).
WaterContent FunctionSequence

Water content calculation based on ASTM D2216.

AtterbergLimits class-attribute instance-attribute 

AtterbergLimits: FunctionSequence = FunctionSequence(
    (
        soil_lab.get_liquid_limit,
        soil_lab.get_plasticity_index,
        soil_lab.get_liquidity_index,
    )
)

Atterberg limits calculation based on ASTM D4318.

References
  • astm2017d4318

CPTFootingCapacityRobertson class-attribute instance-attribute 

CPTFootingCapacityRobertson: FunctionSequence = (
    FunctionSequence(
        (
            cpt.get_is_invalid_data,
            cpt.get_corrected_cone_tip_resistance,
            footing.get_footing_influence_depth,
            cpt.get_mean_corrected_cone_tip_resistance,
            cpt.get_ultimate_bearing_capacity_cpt,
        )
    )
)

Shallow footing ultimate bearing capacity from CPT data based on Robertson's CPT guide (2024).

References
  • robertson2024guide

CPTFootingSettlementsRobertson class-attribute instance-attribute 

CPTFootingSettlementsRobertson: FunctionSequence = (
    FunctionSequence(
        (
            base.get_thickness,
            base.get_depth_middle,
            cpt.get_is_invalid_data,
            cpt.get_corrected_cone_tip_resistance,
            cpt.get_friction_ratio,
            cpt.get_unit_weight__robertson2010estimatinga,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            cpt.get_normalized_friction_ratio,
            cpt.get_overburden_stress_exponent__robertson2009interpretation,
            spt.get_overburden_correction__liao1986overburden,
            cpt.get_stress_normalized_cone_resistance,
            cpt.get_soil_behavior_type_index,
            cpt.get_soil_transition,
            cpt.get_constrained_modulus__robertson2022evaluation,
            footing.get_stress_influence_factor,
            footing.get_imposed_stress,
            footing.get_footing_settlement_inc,
            footing.get_footing_creep_settlement_inc,
            footing.get_footing_settlement,
            footing.get_footing_settlement_sum,
            footing.get_footing_creep_settlement_sum,
        )
    )
)

Shallow footing settlement from CPT data based on Robertson's CPT guide (2024).

References
  • robertson2024guide

CPTInterpretationRobertson class-attribute instance-attribute 

CPTInterpretationRobertson: FunctionSequence = (
    FunctionSequence(
        (
            base.get_below_water_table,
            base.get_thickness,
            base.get_depth_middle,
            cpt.get_is_invalid_data,
            cpt.get_corrected_cone_tip_resistance,
            cpt.get_friction_ratio,
            cpt.get_unit_weight__robertson2010estimatinga,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            cpt.get_alternative_normalized_friction_ratio,
            cpt.get_alternative_normalized_cone_resistance,
            cpt.get_normalized_friction_ratio,
            cpt.get_normalized_pore_pressure_ratio,
            cpt.get_overburden_stress_exponent__robertson2009interpretation,
            spt.get_overburden_correction__liao1986overburden,
            cpt.get_non_normalized_soil_behavior_type_index,
            cpt.get_stress_normalized_cone_resistance,
            cpt.get_soil_behavior_type_index,
            cpt.get_soil_transition,
            cpt.get_fines_content__robertson1998evaluating,
            cpt.get_normalized_pore_pressure,
            cpt.get_modified_soil_behavior_type_index,
            cpt.get_normalized_cone_resistance,
            cpt.get_soil_behavior_type,
            cpt.get_soil_behavior_type_label,
            cpt.get_normalized_soil_behavior_type,
            cpt.get_normalized_soil_behavior_type_label,
            cpt.get_modified_soil_behavior_type,
            cpt.get_modified_soil_behavior_type_label,
            cpt.get_soil_behavior_type_schneider,
            cpt.get_soil_behavior_type_schneider_label,
            cpt.get_is_fine_soil_cpt,
            cpt.get_corrected_blow_count__robertson2012interpretation,
            cpt.get_behaviour_correction_factor__robertson2022evaluation,
            cpt.get_clean_sand_normalized_cone_resistance__robertson2009interpretation,
            cpt.get_relative_density__robertson2024guide,
            cpt.get_state_parameter__robertson2012interpretation,
            cpt.get_sensitivity__robertson2009interpretation,
            cpt.get_friction_angle__robertson2012interpretation,
            cpt.get_undrained_shear_strength_factor__robertson2012interpretation,
            cpt.get_undrained_shear_strength__robertson2012interpretation,
            base.get_undrained_shear_strength_ratio,
            base.get_shear_strength__terzaghi1943theoretical,
            cpt.get_overconsolidation_ratio_factor__robertson2012interpretation,
            cpt.get_overconsolidation_ratio__robertson2012interpretation,
            cpt.get_elasticity_modulus__robertson2012interpretation,
            cpt.get_permeability__robertson2010estimatingb,
            cpt.get_shear_velocity__robertson2022evaluation,
            base.get_small_strain_shear_modulus__landau1959theory,
            cpt.get_constrained_modulus__robertson2022evaluation,
            base.get_coefficient_of_consolidation__terzaghi1925principles,
            cpt.get_peak_friction_angle__mayne2005integrated,
            base.get_coefficient_of_earth_pressure_at_rest__mayne1982ko,
            cpt.get_normalized_residual_shear_strength__robertson2022evaluation,
            liquefaction.get_post_liquefaction_residual_shear_strength,
            cpt.get_water_content__barounis2018estimation,
            cpt.get_void_ratio_cpt__barounis2018estimation,
            cpt.get_dry_unit_weight__barounis2018estimation,
            cpt.get_porosity__barounis2018estimation,
            cpt.get_plasticity_index__ramsey2023estimating,
        )
    )
)

Comprehensive CPT interpretation of soil behavior type and geotechnical parameters based on Robertson's CPT guide (2024).

References
  • robertson2024guide

CPTLiquefactionBoulanger2014 class-attribute instance-attribute 

CPTLiquefactionBoulanger2014: FunctionSequence = (
    FunctionSequence(
        (
            base.get_below_water_table,
            base.get_thickness,
            base.get_depth_middle,
            cpt.get_is_invalid_data,
            cpt.get_corrected_cone_tip_resistance,
            cpt.get_friction_ratio,
            cpt.get_unit_weight__robertson2010estimatinga,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            cpt.get_normalized_friction_ratio,
            cpt.get_overburden_stress_exponent__robertson2009interpretation,
            spt.get_overburden_correction__liao1986overburden,
            cpt.get_stress_normalized_cone_resistance,
            cpt.get_soil_behavior_type_index,
            cpt.get_soil_transition,
            cpt.get_fines_content__boulanger2014cpt,
            cpt.get_normalized_soil_behavior_type,
            cpt.get_is_fine_soil_cpt,
            cpt.get_iterative_parameters_cpt__boulanger2014cpt,
            cpt.get_behaviour_correction_factor__robertson2022evaluation,
            cpt.get_clean_sand_normalized_cone_resistance__robertson2009interpretation,
            cpt.get_undrained_shear_strength_factor__robertson2012interpretation,
            cpt.get_undrained_shear_strength__robertson2012interpretation,
            cpt.get_normalized_cone_resistance_fines_inc_sr__seed1987design,
            cpt.get_clean_sand_normalized_cone_resistance_1atm_sr__idriss2003estimating,
            cpt.get_friction_angle__kulhawy1990manual,
            cpt.get_normalized_residual_shear_strength_cpt__idriss2008soil,
            liquefaction.get_post_liquefaction_residual_shear_strength,
            cpt.get_peak_undrained_shear_strength_ratio__idriss2008soil,
            cpt.get_is_potentially_liquefiable_cpt,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__idriss2006semi,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            cpt.get_magnitude_scaling_factor_max_cpt__boulanger2014cpt,
            liquefaction.get_magnitude_scaling_factor__boulanger2014cpt,
            liquefaction.get_initial_static_shear_correction,
            cpt.get_overburden_correction_coefficient_cpt__idriss2008soil,
            liquefaction.get_overburden_correction_crr__idriss2006semi,
            cpt.get_cyclic_resistance_ratio_magnitude_7_5_cpt__boulanger2014cpt,
            liquefaction.get_cyclic_resistance_ratio,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_liquefaction_probability__boulanger2014cpt,
            cpt.get_shear_strain_limit_cpt__idriss2008soil,
            cpt.get_max_shear_strain_f_alpha_term_cpt__idriss2008soil,
            liquefaction.get_max_shear_strain__idriss2008soil,
            liquefaction.get_lateral_displacement_index_inc,
            liquefaction.get_lateral_displacement_inc__idriss2008soil,
            cpt.get_volumetric_strain_cpt__idriss2008soil,
            liquefaction.get_liquefaction_settlement_inc,
        )
    )
    + LiquefactionSummary
)

CPT-based liquefaction triggering and settlement analysis based on Boulanger and Idriss (2014).

References
  • boulanger2014cpt

CPTLiquefactionIdriss2008 class-attribute instance-attribute 

CPTLiquefactionIdriss2008: FunctionSequence = (
    FunctionSequence(
        (
            base.get_below_water_table,
            base.get_thickness,
            base.get_depth_middle,
            cpt.get_is_invalid_data,
            cpt.get_corrected_cone_tip_resistance,
            cpt.get_friction_ratio,
            cpt.get_unit_weight__robertson2010estimatinga,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            cpt.get_normalized_friction_ratio,
            cpt.get_overburden_stress_exponent__robertson2009interpretation,
            spt.get_overburden_correction__liao1986overburden,
            cpt.get_stress_normalized_cone_resistance,
            cpt.get_soil_behavior_type_index,
            cpt.get_soil_transition,
            cpt.get_fines_content__idriss2008soil,
            cpt.get_normalized_soil_behavior_type,
            cpt.get_is_fine_soil_cpt,
            cpt.get_iterative_parameters_cpt__idriss2008soil,
            cpt.get_behaviour_correction_factor__robertson2022evaluation,
            cpt.get_clean_sand_normalized_cone_resistance__robertson2009interpretation,
            cpt.get_undrained_shear_strength_factor__robertson2012interpretation,
            cpt.get_undrained_shear_strength__robertson2012interpretation,
            cpt.get_normalized_cone_resistance_fines_inc_sr__seed1987design,
            cpt.get_clean_sand_normalized_cone_resistance_1atm_sr__idriss2003estimating,
            cpt.get_friction_angle__kulhawy1990manual,
            cpt.get_normalized_residual_shear_strength_cpt__idriss2008soil,
            liquefaction.get_post_liquefaction_residual_shear_strength,
            cpt.get_peak_undrained_shear_strength_ratio__idriss2008soil,
            cpt.get_is_potentially_liquefiable_cpt,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__idriss2006semi,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            liquefaction.get_magnitude_scaling_factor__idriss2008soil,
            liquefaction.get_initial_static_shear_correction,
            cpt.get_overburden_correction_coefficient_cpt__idriss2008soil,
            liquefaction.get_overburden_correction_crr__idriss2006semi,
            cpt.get_cyclic_resistance_ratio_magnitude_7_5_cpt__idriss2006semi,
            liquefaction.get_cyclic_resistance_ratio,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_liquefaction_probability__idriss2008soil,
            cpt.get_shear_strain_limit_cpt__idriss2008soil,
            cpt.get_max_shear_strain_f_alpha_term_cpt__idriss2008soil,
            liquefaction.get_max_shear_strain__idriss2008soil,
            liquefaction.get_lateral_displacement_index_inc,
            liquefaction.get_lateral_displacement_inc__idriss2008soil,
            cpt.get_volumetric_strain_cpt__idriss2008soil,
            liquefaction.get_liquefaction_settlement_inc,
        )
    )
    + LiquefactionSummary
)

CPT-based liquefaction triggering and settlement analysis based on Idriss and Boulanger (2008).

References
  • idriss2008soil

CPTLiquefactionRobertson class-attribute instance-attribute 

CPTLiquefactionRobertson: FunctionSequence = (
    FunctionSequence(
        (
            base.get_below_water_table,
            base.get_thickness,
            base.get_depth_middle,
            cpt.get_is_invalid_data,
            cpt.get_corrected_cone_tip_resistance,
            cpt.get_friction_ratio,
            cpt.get_unit_weight__robertson2010estimatinga,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            cpt.get_normalized_friction_ratio,
            cpt.get_overburden_stress_exponent__robertson2009interpretation,
            spt.get_overburden_correction__liao1986overburden,
            cpt.get_stress_normalized_cone_resistance,
            cpt.get_soil_behavior_type_index,
            cpt.get_soil_transition,
            cpt.get_fines_content__robertson1998evaluating,
            cpt.get_normalized_soil_behavior_type,
            cpt.get_is_fine_soil_cpt,
            cpt.get_behaviour_correction_factor__robertson2022evaluation,
            cpt.get_clean_sand_normalized_cone_resistance__robertson2009interpretation,
            cpt.get_friction_angle__robertson2012interpretation,
            cpt.get_undrained_shear_strength_factor__robertson2012interpretation,
            cpt.get_undrained_shear_strength__robertson2012interpretation,
            base.get_undrained_shear_strength_ratio,
            base.get_shear_strength__terzaghi1943theoretical,
            cpt.get_normalized_residual_shear_strength_liq__robertson2022evaluation,
            liquefaction.get_post_liquefaction_residual_shear_strength,
            cpt.get_peak_undrained_shear_strength_ratio__robertson2022evaluation,
            cpt.get_is_potentially_liquefiable_cpt,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__youd2001liquefaction,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            liquefaction.get_magnitude_scaling_factor__youd2001liquefaction,
            liquefaction.get_initial_static_shear_correction,
            liquefaction.get_overburden_correction_crr__hynes2018influence,
            cpt.get_cyclic_resistance_ratio_magnitude_7_5__robertson2009interpretation,
            liquefaction.get_cyclic_resistance_ratio,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_liquefaction_probability__ku2012probabilistic,
            cpt.get_relative_density__tatsuoka1990evaluation,
            cpt.get_max_shear_strain__zhang2004estimating,
            liquefaction.get_lateral_displacement_index_inc,
            liquefaction.get_lateral_spread_displacement_inc__zhang2004estimating,
            cpt.get_volumetric_strain__zhang2002estimating,
            liquefaction.get_liquefaction_settlement_inc,
        )
    )
    + LiquefactionSummary
)

CPT-based liquefaction triggering and settlement analysis based on Robertson's CPT guide (2024).

References
  • robertson2024guide

CPTLiquefactionSaye2021 class-attribute instance-attribute 

CPTLiquefactionSaye2021: FunctionSequence = (
    FunctionSequence(
        (
            base.get_below_water_table,
            base.get_thickness,
            base.get_depth_middle,
            cpt.get_is_invalid_data,
            cpt.get_corrected_cone_tip_resistance,
            cpt.get_friction_ratio,
            cpt.get_unit_weight__robertson2010estimatinga,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            cpt.get_normalized_friction_ratio,
            cpt.get_overburden_stress_exponent__robertson2009interpretation,
            spt.get_overburden_correction__liao1986overburden,
            cpt.get_stress_normalized_cone_resistance,
            cpt.get_soil_behavior_type_index,
            cpt.get_soil_transition,
            cpt.get_normalized_soil_behavior_type,
            cpt.get_is_fine_soil_cpt,
            cpt.get_behaviour_correction_factor__robertson2022evaluation,
            cpt.get_clean_sand_normalized_cone_resistance__robertson2009interpretation,
            cpt.get_alternative_normalized_cone_resistance,
            spt.get_overburden_stress_exponent__liao1986overburden,
            spt.get_overburden_correction__liao1986overburden,
            cpt.get_soil_classification_index__saye2017linear,
            cpt.get_soil_classification_index_label__saye2017linear,
            cpt.get_soil_classification_index_uscs_symbol__saye2017linear,
            cpt.get_fines_content__saye2017linear,
            cpt.get_diameter_at_50_percent_finer__saye2017linear,
            cpt.get_is_potentially_liquefiable_cpt,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__liao1986catalog,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            liquefaction.get_magnitude_scaling_factor__youd2001liquefaction,
            cpt.get_cyclic_resistance_ratio_slope__saye2021common,
            cpt.get_overburden_normalized_cone_resistance__saye2021common,
            cpt.get_cyclic_resistance_ratio_magnitude_7_5__saye2021common,
            liquefaction.get_cyclic_resistance_ratio__saye2021common,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_liquefaction_probability__ku2012probabilistic,
            cpt.get_relative_density__tatsuoka1990evaluation,
            cpt.get_max_shear_strain__zhang2004estimating,
            liquefaction.get_lateral_displacement_index_inc,
            liquefaction.get_lateral_spread_displacement_inc__zhang2004estimating,
            cpt.get_volumetric_strain__zhang2002estimating,
            liquefaction.get_liquefaction_settlement_inc,
        )
    )
    + LiquefactionSummary
)

CPT-based liquefaction triggering analysis based on Saye et al. (2021). The linear soil classification index of Saye et al. (2017) is used.

References
  • saye2021common
  • saye2017linear

CPTPileBustamante1982 class-attribute instance-attribute 

CPTPileBustamante1982: FunctionSequence = FunctionSequence(
    (
        base.get_thickness,
        cpt.get_is_invalid_data,
        cpt.get_corrected_cone_tip_resistance,
        cpt.get_friction_ratio,
        cpt.get_unit_weight__robertson2010estimatinga,
        base.get_total_stress,
        base.get_pore_water_pressure,
        base.get_effective_stress,
        cpt.get_normalized_friction_ratio,
        cpt.get_overburden_stress_exponent__robertson2009interpretation,
        spt.get_overburden_correction__liao1986overburden,
        cpt.get_stress_normalized_cone_resistance,
        pile.get_pile_perimeter,
        pile.get_pile_tip_area,
        pile.get_pile_side_surface_area,
        cpt.get_equivalent_cone_resistance__bustamante1982pile,
        cpt.get_nature_of_soil__bustamante1982pile,
        cpt.get_pile_tip_resistance_factor__bustamante1982pile,
        cpt.get_pile_unit_tip_resistance__bustamante1982pile,
        pile.get_pile_tip_resistance,
        cpt.get_pile_friction_coefficient__bustamante1982pile,
        cpt.get_unit_side_friction_limit__bustamante1982pile,
        cpt.get_unit_side_friction__bustamante1982pile,
        pile.get_pile_shaft_resistance_inc,
        pile.get_pile_shaft_resistance,
        pile.get_pile_ultimate_resistance,
    )
)

Pile capacity from CPT data based on the Bustamante and Gianeselli (1982) LCPC method.

References
  • bustamante1982pile

CPTPileBustamante1982Fellenius class-attribute instance-attribute 

CPTPileBustamante1982Fellenius: FunctionSequence = (
    FunctionSequence(
        (
            base.get_thickness,
            cpt.get_is_invalid_data,
            cpt.get_corrected_cone_tip_resistance,
            cpt.get_friction_ratio,
            cpt.get_unit_weight__robertson2010estimatinga,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            cpt.get_normalized_friction_ratio,
            cpt.get_overburden_stress_exponent__robertson2009interpretation,
            spt.get_overburden_correction__liao1986overburden,
            cpt.get_stress_normalized_cone_resistance,
            pile.get_pile_perimeter,
            pile.get_pile_tip_area,
            pile.get_pile_side_surface_area,
            cpt.get_equivalent_cone_resistance__bustamante1982pile,
            cpt.get_effective_cone_resistance__eslami1997pile,
            cpt.get_soil_type_index,
            cpt.get_soil_type_index_label,
            cpt.get_is_fine_soil_bustamante1982fellenius,
            cpt.get_pile_tip_resistance_factor__bustamante1982fellenius,
            cpt.get_pile_unit_tip_resistance__bustamante1982pile,
            pile.get_pile_tip_resistance,
            cpt.get_pile_friction_coefficient__bustamante1982fellenius,
            cpt.get_unit_side_friction_limit__bustamante1982fellenius,
            cpt.get_unit_side_friction__bustamante1982pile,
            pile.get_pile_shaft_resistance_inc,
            pile.get_pile_shaft_resistance,
            pile.get_pile_ultimate_resistance,
        )
    )
)

Pile capacity from CPT data based on the Bustamante and Gianeselli (1982) LCPC method as simplified in the Canadian Foundation Engineering Manual (1992). Clay versus sand is taken from the Eslami and Fellenius (1997) soil-type index rather than the original LCPC nature-of-soil chart.

References
  • bustamante1982pile
  • cgs1992canadian
  • eslami1997pile

CPTPileEslami1997 class-attribute instance-attribute 

CPTPileEslami1997: FunctionSequence = FunctionSequence(
    (
        base.get_thickness,
        cpt.get_is_invalid_data,
        cpt.get_corrected_cone_tip_resistance,
        pile.get_pile_perimeter,
        pile.get_pile_tip_area,
        pile.get_pile_side_surface_area,
        cpt.get_effective_cone_resistance__eslami1997pile,
        cpt.get_soil_type_index,
        cpt.get_soil_type_index_label,
        cpt.get_effective_cone_resistance_geometric_mean__eslami1997pile,
        cpt.get_pile_tip_resistance_coefficient__eslami1997pile,
        cpt.get_pile_unit_tip_resistance__eslami1997pile,
        pile.get_pile_tip_resistance,
        cpt.get_unit_side_friction_coefficient__eslami1997pile,
        cpt.get_unit_side_friction__eslami1997pile,
        pile.get_pile_shaft_resistance_inc,
        pile.get_pile_shaft_resistance,
        pile.get_pile_ultimate_resistance,
    )
)

Pile capacity from CPT data based on the Eslami and Fellenius (1997) method.

References
  • eslami1997pile

DMTFootingSettlementsRobertson class-attribute instance-attribute 

DMTFootingSettlementsRobertson: FunctionSequence = (
    FunctionSequence(
        (
            base.get_below_water_table,
            base.get_thickness,
            base.get_pore_water_pressure,
            dmt.get_corrected_pressure_p0,
            dmt.get_corrected_pressure_p1,
            dmt.get_material_index,
            dmt.get_dilatometer_modulus,
            dmt.get_unit_weight__marchetti1981flat,
            base.get_total_stress,
            base.get_effective_stress,
            dmt.get_is_fine_soil_dmt,
            dmt.get_horizontal_stress_index,
            dmt.get_constrained_modulus__marchetti1981flat,
            footing.get_stress_influence_factor,
            footing.get_imposed_stress,
            footing.get_footing_settlement_inc,
            footing.get_footing_settlement,
            footing.get_footing_settlement_sum,
        )
    )
)

Shallow footing settlement from flat dilatometer (DMT) data based on Marchetti (1981).

References
  • marchetti1981flat

DMTInterpretationMarchetti class-attribute instance-attribute 

DMTInterpretationMarchetti: FunctionSequence = (
    FunctionSequence(
        (
            base.get_below_water_table,
            base.get_thickness,
            base.get_depth_middle,
            base.get_pore_water_pressure,
            dmt.get_corrected_pressure_p0,
            dmt.get_corrected_pressure_p1,
            dmt.get_corrected_pressure_p2,
            dmt.get_material_index,
            dmt.get_dilatometer_modulus,
            dmt.get_pore_pressure_index,
            dmt.get_unit_weight__marchetti1981flat,
            base.get_total_stress,
            base.get_effective_stress,
            dmt.get_is_fine_soil_dmt,
            dmt.get_horizontal_stress_index,
            dmt.get_material_description,
            dmt.get_relative_density__reyna1991dilatometer,
            dmt.get_friction_angle__marchetti1997flat,
            dmt.get_undrained_shear_strength__marchetti1981flat,
            dmt.get_overconsolidation_ratio__marchetti1981flat,
            dmt.get_constrained_modulus__marchetti1981flat,
            dmt.get_elasticity_modulus__marchetti1981flat,
            dmt.get_shear_modulus__amoroso2013prediction,
            base.get_shear_velocity__landau1959theory,
            dmt.get_coefficient_of_earth_pressure_at_rest__marchetti1981flat,
        )
    )
)

Flat dilatometer (DMT) interpretation of soil parameters based on Marchetti (1981). Shear modulus is predicted from Amoroso et al. (2013).

References
  • marchetti1981flat
  • amoroso2013prediction

DMTLiquefactionMarchetti class-attribute instance-attribute 

DMTLiquefactionMarchetti: FunctionSequence = (
    FunctionSequence(
        (
            base.get_below_water_table,
            base.get_thickness,
            base.get_depth_middle,
            base.get_pore_water_pressure,
            dmt.get_corrected_pressure_p0,
            dmt.get_corrected_pressure_p1,
            dmt.get_corrected_pressure_p2,
            dmt.get_material_index,
            dmt.get_dilatometer_modulus,
            dmt.get_unit_weight__marchetti1981flat,
            base.get_total_stress,
            base.get_effective_stress,
            dmt.get_is_fine_soil_dmt,
            dmt.get_horizontal_stress_index,
            cpt.get_clean_sand_normalized_cone_resistance__robertson2012interpretation,
            dmt.get_is_potentially_liquefiable_dmt,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__youd2001liquefaction,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            liquefaction.get_magnitude_scaling_factor__youd2001liquefaction,
            liquefaction.get_initial_static_shear_correction,
            liquefaction.get_overburden_correction_crr__hynes2018influence,
            cpt.get_cyclic_resistance_ratio_magnitude_7_5__robertson2009interpretation,
            liquefaction.get_cyclic_resistance_ratio,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_liquefaction_probability__ku2012probabilistic,
            dmt.get_relative_density__reyna1991dilatometer,
            cpt.get_max_shear_strain__zhang2004estimating,
            liquefaction.get_lateral_displacement_index_inc,
            liquefaction.get_lateral_spread_displacement_inc__zhang2004estimating,
            cpt.get_volumetric_strain__zhang2002estimating,
            liquefaction.get_liquefaction_settlement_inc,
        )
    )
    + LiquefactionSummary
)

DMT-based liquefaction triggering and settlement analysis. Marchetti (1981) DMT correlations are combined with Robertson's CPT-based liquefaction procedures.

References
  • marchetti1981flat
  • robertson2012interpretation
  • robertson2024guide

FootingAverageParameters class-attribute instance-attribute 

FootingAverageParameters: FunctionSequence = (
    FunctionSequence(
        (
            footing.get_average_parameters__bowles1996foundation,
        )
    )
)

Average soil parameters for footing design based on Bowles (1996).

References
  • bowles1996foundation

FootingCapacityMeyerhof1978StrongSandOnSoftSaturatedClay class-attribute instance-attribute 

FootingCapacityMeyerhof1978StrongSandOnSoftSaturatedClay: (
    FunctionSequence
) = FunctionSequence(
    (
        footing.get_footing_total_stress,
        footing.get_footing_pore_water_pressure,
        footing.get_footing_effective_stress,
        footing.get_bearing_capacity_factor_surcharge__vesic1975bearing,
        footing.get_bearing_capacity_factor_unit_weight__vesic1975bearing,
        footing.get_shape_factor_surcharge__vesic1975bearing,
        footing.get_shape_factor_unit_weight__vesic1975bearing,
        footing.get_effective_unit_weight__vesic1973analysis,
        footing.get_bearing_capacity_factor_cohesion_bottom_layer__vesic1975bearing,
        footing.get_bearing_capacity_ratio_case1__meyerhof1978ultimate,
        footing.get_punching_shear_coefficient__meyerhof1978ultimate,
        footing.get_ultimate_bearing_capacity_limit_case1and2__meyerhof1978ultimate,
        footing.get_ultimate_bearing_capacity_case1__meyerhof1978ultimate,
    )
)

Bearing capacity of a strong sand layer overlying soft saturated clay based on Meyerhof and Hanna (1978).

References
  • meyerhof1978ultimate

FootingCapacityMeyerhof1978StrongSandOnWeakSand class-attribute instance-attribute 

FootingCapacityMeyerhof1978StrongSandOnWeakSand: (
    FunctionSequence
) = FunctionSequence(
    (
        footing.get_footing_total_stress,
        footing.get_footing_pore_water_pressure,
        footing.get_footing_effective_stress,
        footing.get_bearing_capacity_factor_surcharge__vesic1975bearing,
        footing.get_bearing_capacity_factor_surcharge_bottom_layer__vesic1975bearing,
        footing.get_effective_unit_weight__vesic1973analysis,
        footing.get_effective_unit_weight_bottom_layer__vesic1973analysis,
        footing.get_bearing_capacity_factor_unit_weight__vesic1975bearing,
        footing.get_bearing_capacity_factor_unit_weight_bottom_layer__vesic1975bearing,
        footing.get_bearing_capacity_ratio_case2__meyerhof1978ultimate,
        footing.get_punching_shear_coefficient__meyerhof1978ultimate,
        footing.get_shape_factor_surcharge__vesic1975bearing,
        footing.get_shape_factor_surcharge_bottom_layer__vesic1975bearing,
        footing.get_shape_factor_unit_weight__vesic1975bearing,
        footing.get_ultimate_bearing_capacity_limit_case1and2__meyerhof1978ultimate,
        footing.get_ultimate_bearing_capacity_case2__meyerhof1978ultimate,
    )
)

Bearing capacity of a strong sand layer overlying weak sand based on Meyerhof and Hanna (1978).

References
  • meyerhof1978ultimate

FootingCapacityMeyerhof1978StrongSaturatedClayOnSoftSaturatedClay class-attribute instance-attribute 

FootingCapacityMeyerhof1978StrongSaturatedClayOnSoftSaturatedClay: (
    FunctionSequence
) = FunctionSequence(
    (
        footing.get_footing_total_stress,
        footing.get_footing_pore_water_pressure,
        footing.get_footing_effective_stress,
        footing.get_effective_unit_weight__vesic1973analysis,
        footing.get_unit_adhesion_to_cohesion_ratio__meyerhof1978ultimate,
        footing.get_unit_adhesion__meyerhof1978ultimate,
        footing.get_ultimate_bearing_capacity_limit_case3__meyerhof1978ultimate,
        footing.get_ultimate_bearing_capacity_case3__meyerhof1978ultimate,
    )
)

Bearing capacity of a strong saturated clay layer overlying soft saturated clay based on Meyerhof and Hanna (1978).

References
  • meyerhof1978ultimate

FootingCapacityTerzaghi1943 class-attribute instance-attribute 

FootingCapacityTerzaghi1943: FunctionSequence = (
    FunctionSequence(
        (
            footing.get_footing_total_stress,
            footing.get_footing_pore_water_pressure,
            footing.get_footing_effective_stress,
            footing.get_bearing_capacity_factor_surcharge__terzaghi1943theoretical,
            footing.get_bearing_capacity_factor_cohesion__terzaghi1943theoretical,
            footing.get_bearing_capacity_factor_unit_weight__terzaghi1943theoretical,
            footing.get_effective_unit_weight__vesic1973analysis,
            footing.get_ultimate_bearing_capacity__terzaghi1943theoretical,
        )
    )
)

Shallow footing ultimate bearing capacity based on Terzaghi's (1943) bearing capacity theory.

References
  • terzaghi1943theoretical

FootingCapacityVesic1975 class-attribute instance-attribute 

FootingCapacityVesic1975: FunctionSequence = (
    FunctionSequence(
        (
            footing.get_footing_total_stress,
            footing.get_footing_pore_water_pressure,
            footing.get_footing_effective_stress,
            footing.get_bearing_capacity_factor_surcharge__vesic1975bearing,
            footing.get_bearing_capacity_factor_cohesion__vesic1975bearing,
            footing.get_bearing_capacity_factor_unit_weight__vesic1975bearing,
            footing.get_shape_factor_cohesion__vesic1975bearing,
            footing.get_shape_factor_surcharge__vesic1975bearing,
            footing.get_shape_factor_unit_weight__vesic1975bearing,
            footing.get_footing_embedment_to_width_ratio__vesic1975bearing,
            footing.get_depth_factor_cohesion__vesic1975bearing,
            footing.get_depth_factor_surcharge__vesic1975bearing,
            footing.get_depth_factor_unit_weight__vesic1975bearing,
            footing.get_effective_unit_weight__vesic1973analysis,
            footing.get_ultimate_bearing_capacity__vesic1975bearing,
        )
    )
)

Shallow footing ultimate bearing capacity with shape and depth factors based on Vesic (1975).

References
  • vesic1975bearing

HydrometerAnalysis class-attribute instance-attribute 

HydrometerAnalysis: FunctionSequence = FunctionSequence(
    (
        soil_lab.get_temperature_correction,
        soil_lab.get_specific_gravity_correction,
        soil_lab.get_a_parameter,
        soil_lab.get_corrected_hydrometer_reading,
        soil_lab.get_percent_finer_uncorrected,
        soil_lab.get_effective_length_corrected_reading,
        soil_lab.get_effective_length,
        soil_lab.get_particle_size,
        soil_lab.get_hydrometer_percent_finer,
        soil_lab.get_percent_clay,
        soil_lab.get_percent_silt,
    )
)

Hydrometer analysis calculation based on ASTM D422.

References
  • astm2007d422

LiquefactionFinesBray2006 class-attribute instance-attribute 

LiquefactionFinesBray2006: FunctionSequence = (
    FunctionSequence(
        (
            soil_lab.get_water_content_liquid_limit_ratio,
            liquefaction.get_liquefaction_susceptibility__bray2006assessment,
        )
    )
)

Fine-grained soil liquefaction susceptibility screening based on Bray and Sancio (2006).

References
  • bray2006assessment

LiquefactionShearInducedBuildingSettlementBray2017 class-attribute instance-attribute 

LiquefactionShearInducedBuildingSettlementBray2017: (
    FunctionSequence
) = FunctionSequence(
    (
        liquefaction.get_liquefaction_building_settlement_index__bray2017simplified,
        liquefaction.get_liquefaction_shear_induced_building_settlement__bray2017simplified,
    )
)

Shear-induced building settlement from liquefaction based on Bray and Macedo (2017).

References
  • bray2017simplified

LiquefactionSummary class-attribute instance-attribute 

LiquefactionSummary: FunctionSequence = FunctionSequence(
    (
        liquefaction.get_thickness_non_liquefiable_layer,
        liquefaction.get_thickness_liquefiable_layer,
        liquefaction.get_liquefaction_potential_index_inc,
        liquefaction.get_liquefaction_severity_number_inc__van2014assessment,
        liquefaction.get_lateral_displacement_index,
        liquefaction.get_lateral_spread_displacement,
        liquefaction.get_liquefaction_settlement,
        liquefaction.get_liquefaction_potential_index,
        liquefaction.get_liquefaction_severity_number,
        liquefaction.get_lateral_displacement_index_sum,
        liquefaction.get_lateral_spread_displacement_sum,
        liquefaction.get_liquefaction_settlement_sum,
        liquefaction.get_liquefaction_potential_index_sum,
        liquefaction.get_liquefaction_potential_index_sum_label,
        liquefaction.get_liquefaction_severity_number_sum,
        liquefaction.get_liquefaction_severity_number_sum_label,
    )
)

Liquefaction potential index, severity, and displacement/settlement summary.

References
  • ishihara1985stability
  • iwasaki1978practical
  • maurer2015moving
  • van2014assessment

LiquefactionYoud2002LateralDisplacement class-attribute instance-attribute 

LiquefactionYoud2002LateralDisplacement: (
    FunctionSequence
) = FunctionSequence(
    (
        liquefaction.get_is_t15_liquefiable_layers,
        liquefaction.get_lateral_spread_displacement_inc__youd2002revised,
    )
)

Lateral spread displacement estimation based on Youd et al. (2002).

References
  • youd2002revised

LiquidLimit class-attribute instance-attribute 

LiquidLimit: FunctionSequence = FunctionSequence(
    (
        soil_lab.get_moisture_mass,
        soil_lab.get_dry_soil_mass,
        soil_lab.get_water_content_trials,
        soil_lab.get_liquid_limit,
    )
)

Liquid limit calculation based on ASTM D4318.

References
  • astm2017d4318

PileCapacityUSACE1991 class-attribute instance-attribute 

PileCapacityUSACE1991: FunctionSequence = FunctionSequence(
    (
        base.get_thickness,
        pile.get_effective_stress__usace1991design,
        pile.get_pile_perimeter,
        pile.get_pile_tip_area,
        pile.get_pile_side_surface_area,
        pile.get_pile_tip_resistance__usace1991design,
        pile.get_pile_friction_coefficient__usace1991design,
        pile.get_unit_side_friction__usace1991design,
        pile.get_pile_shaft_resistance_inc,
        pile.get_pile_shaft_resistance,
        pile.get_pile_ultimate_resistance,
    )
)

Pile axial capacity based on USACE (1991) design procedures.

References
  • usace1991design

PileRockingStiffness class-attribute instance-attribute 

PileRockingStiffness: FunctionSequence = FunctionSequence(
    (
        ssi.get_active_pile_length,
        ssi.get_pile_moment_of_inertia,
        ssi.get_subgrade_reaction_modulus_at_diameter,
        ssi.get_dimensionless_pile_length_parameter_ksd,
        ssi.get_shape_parameter,
        ssi.get_pile_swaying_stiffness,
        ssi.get_pile_rocking_stiffness,
        ssi.get_pile_cross_swaying_rocking_stiffness,
        ssi.get_displacement_rotation,
    )
)

Pile rocking and swaying stiffness for soil-structure interaction analysis.

PileSettlementsBearingPilePoulos1980 class-attribute instance-attribute 

PileSettlementsBearingPilePoulos1980: FunctionSequence = (
    FunctionSequence(
        (
            pile.get_pile_length_to_diameter_ratio,
            pile.get_pile_stiffness_factor__poulos1980pile,
            pile.get_elasticity_modulus_bearing_ratio__poulos1980pile,
            pile.get_basic_influence_factor_i1__poulos1980pile,
            pile.get_pile_settlement_correction_compressibility__poulos1980pile,
            pile.get_pile_settlement_correction_bearing__poulos1980pile,
            pile.get_pile_settlement_correction_poisson__poulos1980pile,
            pile.get_pile_influence_factor_bearing__poulos1980pile,
            pile.get_pile_settlement__poulos1980pile,
        )
    )
)

Settlement of an end-bearing pile based on Poulos and Davis (1980).

References
  • poulos1980pile

PileSettlementsFloatingPilePoulos1980 class-attribute instance-attribute 

PileSettlementsFloatingPilePoulos1980: FunctionSequence = (
    FunctionSequence(
        (
            pile.get_pile_length_to_diameter_ratio,
            pile.get_pile_stiffness_factor__poulos1980pile,
            pile.get_pile_length_to_soil_thickness_ratio,
            pile.get_basic_influence_factor_i1__poulos1980pile,
            pile.get_pile_settlement_correction_compressibility__poulos1980pile,
            pile.get_pile_settlement_correction_depth__poulos1980pile,
            pile.get_pile_settlement_correction_poisson__poulos1980pile,
            pile.get_pile_influence_factor_floating__poulos1980pile,
            pile.get_pile_settlement__poulos1980pile,
        )
    )
)

Settlement of a floating pile based on Poulos and Davis (1980).

References
  • poulos1980pile

PlasticLimit class-attribute instance-attribute 

PlasticLimit: FunctionSequence = FunctionSequence(
    (
        soil_lab.get_moisture_mass,
        soil_lab.get_dry_soil_mass,
        soil_lab.get_water_content_trials,
        soil_lab.get_plastic_limit,
    )
)

Plastic limit calculation based on ASTM D4318.

References
  • astm2017d4318

SPTInterpretation class-attribute instance-attribute 

SPTInterpretation: FunctionSequence = FunctionSequence(
    (
        base.get_soil_type,
        base.get_soil_type2,
        base.get_soil_type3,
        spt.get_is_fine_soil_spt,
        base.get_below_water_table,
        spt.get_energy_ratio_correction__skempton1986standard,
        spt.get_borehole_diameter_correction__skempton1986standard,
        spt.get_rod_length_correction__skempton1986standard,
        spt.get_corrected_blow_count__skempton1986standard,
        base.get_thickness,
        base.get_total_stress,
        base.get_pore_water_pressure,
        base.get_effective_stress,
        soil_lab.get_liquidity_index,
        spt.get_overburden_stress_exponent__liao1986overburden,
        spt.get_overburden_correction__liao1986overburden,
        spt.get_normalized_blow_count__liao1986overburden,
        spt.get_relative_density__idriss2003estimating,
        spt.get_friction_angle__schnaid2009prediction,
        spt.get_normalized_residual_shear_strength__kramer2015empirical,
        liquefaction.get_post_liquefaction_residual_shear_strength,
        spt.get_undrained_shear_strength__sivrikaya2006determination,
        base.get_overconsolidation_ratio__ladd1991stability,
        base.get_consolidation_state,
        spt.get_remolded_undrained_shear_strength__degroot2019engineering,
        spt.get_compression_index__rendon1983closure,
        spt.get_recompression_index__lo1982prediction,
        spt.get_compression_ratio__lambe1969soil,
        spt.get_recompression_ratio__lo1982prediction,
        spt.get_constrained_modulus__janbu1985soil,
        cpt.get_void_ratio__barounis2018estimation,
        spt.get_permeability__chapuis2012predicting,
        spt.get_coefficient_of_consolidation__navfac1982soil,
        spt.get_peak_friction_angle__sorensen2013correlation,
        spt.get_shear_velocity__wair2012guidelines,
        base.get_small_strain_shear_modulus__landau1959theory,
        spt.get_poisson_ratio__bowles1996foundation,
        base.get_elasticity_modulus_from_shear_modulus,
        base.get_coefficient_of_earth_pressure_at_rest__mayne1982ko,
    )
)

Comprehensive geotechnical parameter correlations derived from SPT blow counts.

SPTLiquefactionBoulanger2014 class-attribute instance-attribute 

SPTLiquefactionBoulanger2014: FunctionSequence = (
    FunctionSequence(
        (
            base.get_soil_type,
            base.get_soil_type2,
            spt.get_is_fine_soil_spt,
            base.get_below_water_table,
            base.get_thickness,
            spt.get_is_potentially_liquefiable_spt,
            spt.get_energy_ratio_correction__skempton1986standard,
            spt.get_borehole_diameter_correction__skempton1986standard,
            spt.get_rod_length_correction__skempton1986standard,
            spt.get_corrected_blow_count__skempton1986standard,
            spt.get_unit_weight__cetin2018use,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            spt.get_normalized_blow_count_fines_inc__idriss2006semi,
            spt.get_normalized_blow_count_fines_inc_sr__seed1987design,
            spt.get_iterative_parameters_spt__idriss2008soil,
            spt.get_normalized_blow_count__liao1986overburden,
            spt.get_clean_sand_normalized_blow_count_sr__idriss2003estimating,
            spt.get_normalized_residual_shear_strength_spt__idriss2008soil,
            liquefaction.get_post_liquefaction_residual_shear_strength,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__idriss2006semi,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            liquefaction.get_magnitude_scaling_factor_max_spt__boulanger2014cpt,
            liquefaction.get_magnitude_scaling_factor__boulanger2014cpt,
            liquefaction.get_initial_static_shear_correction,
            liquefaction.get_overburden_correction_coefficient_spt__idriss2008soil,
            liquefaction.get_overburden_correction_crr__idriss2006semi,
            liquefaction.get_cyclic_resistance_ratio_magnitude_7_5_spt__idriss2006semi,
            liquefaction.get_cyclic_resistance_ratio,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_liquefaction_probability__boulanger2012probabilistic,
            liquefaction.get_shear_strain_limit_spt__idriss2008soil,
            liquefaction.get_max_shear_strain_f_alpha_term_spt__idriss2008soil,
            liquefaction.get_max_shear_strain__idriss2008soil,
            liquefaction.get_lateral_displacement_index_inc,
        )
    )
    + LiquefactionYoud2002LateralDisplacement
    + FunctionSequence(
        (
            liquefaction.get_volumetric_strain_spt__idriss2008soil,
            liquefaction.get_liquefaction_settlement_inc,
        )
    )
    + LiquefactionSummary
)

SPT-based liquefaction triggering and settlement analysis based on Boulanger and Idriss (2014).

References
  • boulanger2014cpt

SPTLiquefactionCetin2004 class-attribute instance-attribute 

SPTLiquefactionCetin2004: FunctionSequence = (
    FunctionSequence(
        (
            base.get_soil_type,
            base.get_soil_type2,
            spt.get_is_fine_soil_spt,
            base.get_below_water_table,
            base.get_thickness,
            spt.get_is_potentially_liquefiable_spt,
            spt.get_energy_ratio_correction__skempton1986standard,
            spt.get_borehole_diameter_correction__skempton1986standard,
            spt.get_rod_length_correction__cetin2004standard,
            spt.get_corrected_blow_count__skempton1986standard,
            spt.get_unit_weight__cetin2018use,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            spt.get_overburden_stress_exponent__liao1986overburden,
            spt.get_overburden_correction__cetin2004standard,
            spt.get_normalized_blow_count__liao1986overburden,
            spt.get_fines_content_factor__cetin2004standard,
            spt.get_clean_sand_normalized_blow_count__cetin2004standard,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__cetin2004standard,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            liquefaction.get_initial_static_shear_correction,
            spt.get_relative_density__idriss2003estimating,
            liquefaction.get_overburden_correction_crr__youd2001liquefaction,
            liquefaction.get_liquefaction_probability__cetin2004standard,
            liquefaction.get_cyclic_resistance_ratio__cetin2004standard,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_membrane_compliance_correction__cetin2009probabilistica,
            liquefaction.get_triaxial_planes_correction,
            liquefaction.get_cyclic_stress_ratio_ss_20_1d_1atm__cetin2009probabilistica,
            liquefaction.get_max_shear_strain__cetin2009probabilistica,
            liquefaction.get_lateral_displacement_index_inc,
        )
    )
    + LiquefactionYoud2002LateralDisplacement
    + FunctionSequence(
        (
            liquefaction.get_volumetric_strain_depth_weighting_factor__cetin2009probabilisticb,
            liquefaction.get_volumetric_strain__cetin2009probabilisticb,
            liquefaction.get_liquefaction_settlement_inc,
            spt.get_normalized_residual_shear_strength__weber2015engineering,
            liquefaction.get_post_liquefaction_residual_shear_strength,
        )
    )
    + LiquefactionSummary
)

SPT-based liquefaction triggering and settlement analysis based on Cetin et al. (2004).

References
  • cetin2004standard

SPTLiquefactionCetin2018 class-attribute instance-attribute 

SPTLiquefactionCetin2018: FunctionSequence = (
    FunctionSequence(
        (
            base.get_soil_type,
            base.get_soil_type2,
            spt.get_is_fine_soil_spt,
            base.get_below_water_table,
            base.get_thickness,
            spt.get_is_potentially_liquefiable_spt,
            spt.get_energy_ratio_correction__skempton1986standard,
            spt.get_borehole_diameter_correction__skempton1986standard,
            spt.get_rod_length_correction__cetin2018use,
            spt.get_corrected_blow_count__skempton1986standard,
            spt.get_unit_weight__cetin2018use,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            spt.get_overburden_stress_exponent__liao1986overburden,
            spt.get_overburden_correction__cetin2018use,
            spt.get_normalized_blow_count__liao1986overburden,
            spt.get_normalized_blow_count_fines_inc__cetin2018use,
            spt.get_clean_sand_normalized_blow_count__seed1987design,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__cetin2004standard,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            liquefaction.get_magnitude_scaling_factor__cetin2018use,
            liquefaction.get_initial_static_shear_correction,
            spt.get_relative_density__idriss2003estimating,
            liquefaction.get_overburden_correction_crr__cetin2018use,
            liquefaction.get_liquefaction_probability__cetin2018use,
            liquefaction.get_cyclic_resistance_ratio__cetin2018use,
            liquefaction.get_cyclic_resistance_ratio_magnitude_7_5__cetin2018use,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_membrane_compliance_correction__cetin2009probabilistica,
            liquefaction.get_triaxial_planes_correction,
            liquefaction.get_cyclic_stress_ratio_ss_20_1d_1atm__cetin2009probabilistica,
            liquefaction.get_max_shear_strain__cetin2009probabilistica,
            liquefaction.get_lateral_displacement_index_inc,
        )
    )
    + LiquefactionYoud2002LateralDisplacement
    + FunctionSequence(
        (
            liquefaction.get_volumetric_strain_depth_weighting_factor__cetin2009probabilisticb,
            liquefaction.get_volumetric_strain__cetin2009probabilisticb,
            liquefaction.get_liquefaction_settlement_inc,
            spt.get_normalized_residual_shear_strength__weber2015engineering,
            liquefaction.get_post_liquefaction_residual_shear_strength,
        )
    )
    + LiquefactionSummary
)

SPT-based liquefaction triggering and settlement analysis based on Cetin et al. (2018).

References
  • cetin2018use

SPTLiquefactionIdriss2008 class-attribute instance-attribute 

SPTLiquefactionIdriss2008: FunctionSequence = (
    FunctionSequence(
        (
            base.get_soil_type,
            base.get_soil_type2,
            spt.get_is_fine_soil_spt,
            base.get_below_water_table,
            base.get_thickness,
            spt.get_is_potentially_liquefiable_spt,
            spt.get_energy_ratio_correction__skempton1986standard,
            spt.get_borehole_diameter_correction__skempton1986standard,
            spt.get_rod_length_correction__skempton1986standard,
            spt.get_corrected_blow_count__skempton1986standard,
            spt.get_unit_weight__cetin2018use,
            base.get_total_stress,
            base.get_pore_water_pressure,
            base.get_effective_stress,
            spt.get_normalized_blow_count_fines_inc__idriss2006semi,
            spt.get_normalized_blow_count_fines_inc_sr__seed1987design,
            spt.get_iterative_parameters_spt__idriss2008soil,
            spt.get_normalized_blow_count__liao1986overburden,
            spt.get_clean_sand_normalized_blow_count_sr__idriss2003estimating,
            spt.get_normalized_residual_shear_strength_spt__idriss2008soil,
            liquefaction.get_post_liquefaction_residual_shear_strength,
            liquefaction.get_is_potentially_liquefiable_thickness,
            liquefaction.get_lateral_displacement_potential,
            liquefaction.get_shear_stress_reduction_coefficient__idriss2006semi,
            liquefaction.get_area_replacement_ratio,
            liquefaction.get_shear_stress_reduction_factor__baez1993advances,
            liquefaction.get_stone_column_is_present,
            liquefaction.get_cyclic_stress_ratio,
            liquefaction.get_magnitude_scaling_factor__idriss2008soil,
            liquefaction.get_initial_static_shear_correction,
            liquefaction.get_overburden_correction_coefficient_spt__idriss2008soil,
            liquefaction.get_overburden_correction_crr__idriss2006semi,
            liquefaction.get_cyclic_resistance_ratio_magnitude_7_5_spt__idriss2006semi,
            liquefaction.get_cyclic_resistance_ratio,
            liquefaction.get_liquefaction_safety_factor,
            liquefaction.get_liquefaction_probability__idriss2008soil,
            liquefaction.get_shear_strain_limit_spt__idriss2008soil,
            liquefaction.get_max_shear_strain_f_alpha_term_spt__idriss2008soil,
            liquefaction.get_max_shear_strain__idriss2008soil,
            liquefaction.get_lateral_displacement_index_inc,
        )
    )
    + LiquefactionYoud2002LateralDisplacement
    + FunctionSequence(
        (
            liquefaction.get_volumetric_strain_spt__idriss2008soil,
            liquefaction.get_liquefaction_settlement_inc,
        )
    )
    + LiquefactionSummary
)

SPT-based liquefaction triggering and settlement analysis based on Idriss and Boulanger (2008).

References
  • idriss2008soil

SPTUnitWeightCorrelation class-attribute instance-attribute 

SPTUnitWeightCorrelation: FunctionSequence = (
    FunctionSequence(
        (
            base.get_soil_type2,
            base.get_below_water_table,
            spt.get_energy_ratio_correction__skempton1986standard,
            spt.get_borehole_diameter_correction__skempton1986standard,
            spt.get_rod_length_correction__skempton1986standard,
            spt.get_corrected_blow_count__skempton1986standard,
            spt.get_unit_weight__cetin2018use,
        )
    )
)

Unit weight correlation derived from corrected SPT blow counts.

References
  • cetin2018use

SSIEffects class-attribute instance-attribute 

SSIEffects: FunctionSequence = FunctionSequence(
    (
        ssi.get_footing_half_width,
        ssi.get_footing_half_length,
        ssi.get_effective_profile_depth_rotation,
        ssi.get_average_effective_shear_velocity_xx,
        ssi.get_structure_effective_modal_height,
        ssi.get_structure_to_soil_stiffness_ratio,
        ssi.get_ssi_effects_expected,
        ssi.get_period_lengthening_ratio,
    )
)

Soil-structure interaction (SSI) significance screening based on NIST (2012).

References
  • nist2012soil

SSIFootingStiffness class-attribute instance-attribute 

SSIFootingStiffness: FunctionSequence = FunctionSequence(
    (
        ssi.get_footing_router,
        ssi.get_effective_profile_depth,
        ssi.get_average_top_depth,
        ssi.get_average_bottom_depth,
        ssi.get_average_effective_shear_velocity,
        ssi.get_dimensionless_frequency,
        ssi.get_embedment_factor,
        ssi.get_static_stiffness,
        ssi.get_dynamic_stiffness_modifier,
        ssi.get_radiation_damping_ratio,
        ssi.get_stiffness,
        ssi.get_dashpot_coefficient,
    )
)

Foundation stiffness and damping for a surface footing based on NIST (2012) soil-structure interaction procedures.

References
  • nist2012soil

SSIFootingStiffnessIntensities class-attribute instance-attribute 

SSIFootingStiffnessIntensities: FunctionSequence = (
    FunctionSequence(
        (
            ssi.get_footing_zone,
            ssi.get_vertical_stiffness_intensity,
            ssi.get_stiffness_edge_factor,
            ssi.get_dashpot_coefficient_intensity_vertical,
            ssi.get_stiffness_intensity,
            ssi.get_dashpot_edge_factor,
            ssi.get_dashpot_coefficient_intensity,
        )
    )
)

Distributed footing stiffness and damping intensities based on NIST (2012) soil-structure interaction procedures.

References
  • nist2012soil

SSIIntermediate class-attribute instance-attribute 

SSIIntermediate: FunctionSequence = FunctionSequence(
    (
        ssi.get_natural_frequency,
        ssi.get_footing_half_width,
        ssi.get_footing_half_length,
        ssi.get_active_pile_length,
        ssi.get_poisson_adjustment_factor,
    )
)

Intermediate parameters for soil-structure interaction (SSI) analysis based on NIST (2012).

References
  • nist2012soil

SSINodeData class-attribute instance-attribute 

SSINodeData: FunctionSequence = FunctionSequence(
    (ssi.get_node_data,)
)

Node-level data preparation for soil-structure interaction (SSI) analysis based on NIST (2012).

References
  • nist2012soil

SSIPileStiffness class-attribute instance-attribute 

SSIPileStiffness: FunctionSequence = FunctionSequence(
    (
        ssi.get_pile_router,
        ssi.get_effective_profile_depth_pile,
        ssi.get_average_top_depth,
        ssi.get_average_bottom_depth,
        ssi.get_average_effective_shear_velocity,
        ssi.get_dimensionless_frequency_pile,
        ssi.get_dimensionless_subgrade_reaction_modulus,
        ssi.get_dimensionless_pile_length_parameter,
        ssi.get_dimensionless_pile_tip_stiffness,
        ssi.get_stiffness_weight_factor_soil,
        ssi.get_vibration_constant,
        ssi.get_dynamic_stiffness_modifier_pile,
        ssi.get_static_pile_stiffness,
        ssi.get_stiffness,
    )
)

Pile foundation stiffness and damping based on NIST (2012) soil-structure interaction procedures.

References
  • nist2012soil

SSIPileStiffnessInGroup class-attribute instance-attribute 

SSIPileStiffnessInGroup: FunctionSequence = (
    FunctionSequence(
        (
            ssi.pile_group_router,
            ssi.get_pile_group_efficiency_factor,
            ssi.get_pile_stiffness_in_group,
            ssi.get_pile_group_damping_ratio,
        )
    )
)

Pile group stiffness and damping efficiency based on NIST (2012) soil-structure interaction procedures.

References
  • nist2012soil

SieveAnalysis class-attribute instance-attribute 

SieveAnalysis: FunctionSequence = (
    SieveAnalysisPercentFiner + SieveAnalysisIndexProperties
)

Sieve analysis calculation based on ASTM D421.

References
  • astm2007d421

SieveAnalysisIndexProperties class-attribute instance-attribute 

SieveAnalysisIndexProperties: FunctionSequence = (
    FunctionSequence(
        (
            soil_lab.get_percent_finer_at_sieve_number,
            soil_lab.get_percent_fraction,
            soil_lab.get_percent_finer_diameters,
            soil_lab.get_uniformity_coefficient,
            soil_lab.get_curvature_coefficient,
        )
    )
)

Gradation index properties (uniformity and curvature coefficients) from sieve analysis based on ASTM D421.

References
  • astm2007d421

SieveAnalysisPercentFiner class-attribute instance-attribute 

SieveAnalysisPercentFiner: FunctionSequence = (
    FunctionSequence(
        (
            soil_lab.get_particle_size_from_sieve_number,
            soil_lab.get_cumulative_mass_retained,
            soil_lab.get_percent_finer,
        )
    )
)

Percent finer calculation from sieve analysis mass-retained data based on ASTM D421.

References
  • astm2007d421

SoilClassificationAASHTO class-attribute instance-attribute 

SoilClassificationAASHTO: FunctionSequence = (
    FunctionSequence(
        (
            soil_classification_aashto.get_soil_classification_aashto__astm2015d3282,
        )
    )
)

Soil classification under the AASHTO system based on ASTM D3282.

References
  • astm2015d3282

SoilClassificationUSCS class-attribute instance-attribute 

SoilClassificationUSCS: FunctionSequence = FunctionSequence(
    (
        soil_classification_uscs.get_soil_classification_uscs__astm2017d2487,
    )
)

Soil classification under the Unified Soil Classification System (USCS) based on ASTM D2487.

References
  • astm2017d2487

SoilClassificationUSDA class-attribute instance-attribute 

SoilClassificationUSDA: FunctionSequence = FunctionSequence(
    (
        soil_classification_usda.get_soil_classification__usda1993soil,
    )
)

Soil textural classification based on the USDA soil classification system.

References
  • usda1993soil

SoilClassificationUSDAMoreno2018 class-attribute instance-attribute 

SoilClassificationUSDAMoreno2018: FunctionSequence = (
    FunctionSequence(
        (
            soil_classification_usda.get_soil_classification_usda__moreno2018clay,
        )
    )
)

USDA soil textural classification with adjustments based on Moreno (2018).

References
  • moreno2018clay

WaterContent class-attribute instance-attribute 

WaterContent: FunctionSequence = FunctionSequence(
    (
        soil_lab.get_moisture_mass,
        soil_lab.get_dry_soil_mass,
        soil_lab.get_water_content_trials,
        soil_lab.get_water_content,
    )
)

Water content calculation based on ASTM D2216.

References
  • astm2019d2216

as_dict classmethod 

as_dict() -> dict[str, FunctionSequence]

Return all catalog sequences sorted by name.

get classmethod 

get(name: str) -> FunctionSequence

Return a named sequence from this catalog.

Parameters:

Name Type Description Default
name str

Registry attribute name (e.g. 'SPTInterpretation').

 required

Raises:

Type Description
KeyError

If name is not a registered sequence.