soil

materials.soil

Module containing definitions of soil types and soil materials.

Classes:

• SoilConsistencies –

  Consistencies of the soil.

• SoilConsolidationStates –

  Consolidation states of the soil.

• SoilMainTypes –

  Soil types based on grain size, representing the main portion of the soil mix.

• SoilMinorCompositions –

  Soil minor compositions, representing the minor portion of the soil mix.

• SoilType –

  Class representing a soil type.

materials.soil.SoilConsistencies

Bases: Enum

Consistencies of the soil.

materials.soil.SoilConsolidationStates

Bases: Enum

Consolidation states of the soil.

materials.soil.SoilMainTypes

Bases: Enum

Soil types based on grain size, representing the main portion of the soil mix.

materials.soil.SoilMinorCompositions

Bases: Enum

Soil minor compositions, representing the minor portion of the soil mix.

materials.soil.SoilType dataclass

SoilType(
    main_type: SoilMainTypes,
    minor_composition: SoilMinorCompositions | None = None,
    consolidation_state: SoilConsolidationStates | None = None,
    consistency: SoilConsistencies | None = None,
    description: str | None = None,
)

Class representing a soil type.

Parameters:

• main_type (SoilMainTypes) –

  The soil type of the main portion of the soil mix.

• minor_composition (SoilMinorCompositions, default: None ) –

  The composition of the minor portion of the soil mix, by default None.

• consolidation_state (SoilConsolidationStates, default: None ) –

  The consolidation state of the soil, by default None.

• consistency (SoilConsistencies, default: None ) –

  The consistency of the soil, by default None.

• description (str, default: None ) –

  The custom description of the soil, by default None.

materials.soil.SoilType.default_description property

default_description: str

The default description of the soil type based on the main_type, minor_composition, consolidation_state, and consistency.