geolysis.foundation

CLASS	DESCRIPTION
`Shape`	Enumeration of foundation shapes.
`FoundationType`	Enumeration of foundation types.
`StripFooting`	A class representation of strip footing.
`CircularFooting`	A class representation of circular footing.
`SquareFooting`	A class representation of square footing.
`RectangularFooting`	A class representation of rectangular footing.
`Foundation`	A simple class representing a foundation structure.

FUNCTION	DESCRIPTION
`create_foundation`	A factory function that encapsulate the creation of a foundation.

`Shape`

Bases: AbstractStrEnum

Enumeration of foundation shapes.

Each member represents a standard geometric shape commonly used in foundation design, which can affect bearing capacity and settlement calculations.

ATTRIBUTE	DESCRIPTION
`STRIP`	Strip (or continuous) foundation, typically long and narrow.
`CIRCLE`	Circular foundation, often used for columns or piers.
`SQUARE`	Square foundation, commonly used for isolated footings.
`RECTANGLE`	Rectangular foundation, used when length and width differ significantly.

`STRIP = enum.auto()` `class-attribute` `instance-attribute`

Strip (or continuous) foundation, typically long and narrow.

`CIRCLE = enum.auto()` `class-attribute` `instance-attribute`

Circular foundation, often used for columns or piers.

`SQUARE = enum.auto()` `class-attribute` `instance-attribute`

Square foundation, commonly used for isolated footings.

`RECTANGLE = enum.auto()` `class-attribute` `instance-attribute`

Rectangular foundation, used when length and width differ significantly.

`FoundationType`

Bases: AbstractStrEnum

Enumeration of foundation types.

Each member represents a common type of foundation used in geotechnical engineering. Some members have aliases for alternative naming conventions.

ATTRIBUTE	DESCRIPTION
`PAD`	Pad foundation, a small, isolated footing supporting a single column.
`ISOLATED`	Alias for PAD foundation (isolated footing).
`MAT`	Mat foundation, a large, continuous slab supporting multiple columns or
`RAFT`	Alias for MAT foundation (raft foundation).

`PAD = enum.auto()` `class-attribute` `instance-attribute`

Pad foundation, a small, isolated footing supporting a single column.

`ISOLATED = PAD` `class-attribute` `instance-attribute`

Alias for PAD foundation (isolated footing).

`MAT = enum.auto()` `class-attribute` `instance-attribute`

Mat foundation, a large, continuous slab supporting multiple columns or walls.

`RAFT = MAT` `class-attribute` `instance-attribute`

Alias for MAT foundation (raft foundation).

`FootingSize`

Bases: ABC

ATTRIBUTE	DESCRIPTION
`shape`	Return the shape of the foundation footing. TYPE: `Shape`

`shape` `property`

Return the shape of the foundation footing.

`StripFooting(width, length=inf)`

Bases: FootingSize

A class representation of strip footing.

PARAMETER	DESCRIPTION
`width`	Width of foundation footing (m). TYPE: `float`
`length`	Length of foundation footing (m). TYPE: `float` DEFAULT: `inf`

METHOD	DESCRIPTION
`area`	Area of strip footing (\(m ext{or} m^2\)).

ATTRIBUTE	DESCRIPTION
`width`	Width of foundation footing (m). TYPE: `float`
`length`	Length of foundation footing (m). TYPE: `float`
`shape`	Return the shape of the foundation footing. TYPE: `Shape`

`width` `property` `writable`

Width of foundation footing (m).

`length` `property` `writable`

Length of foundation footing (m).

`shape` `property`

Return the shape of the foundation footing.

`area()`

Area of strip footing (\(m ext{or} m^2\)).

`CircularFooting(diameter)`

Bases: FootingSize

A class representation of circular footing.

Note

The width and length properties refer to the diameter of the circular footing. This is to make it compatible with the protocol square and rectangular footing follow.

PARAMETER	DESCRIPTION
`diameter`	Diameter of foundation footing (m). TYPE: `float`

METHOD	DESCRIPTION
`area`	Area of circular footing (\(m^2\)).

ATTRIBUTE	DESCRIPTION
`diameter`	Diameter of foundation footing (m). TYPE: `float`
`width`	Diameter of foundation footing (m).
`length`	Diameter of foundation footing (m).
`shape`	Return the shape of the foundation footing. TYPE: `Shape`

`diameter` `property` `writable`

Diameter of foundation footing (m).

`width` `property` `writable`

Diameter of foundation footing (m).

`length` `property` `writable`

Diameter of foundation footing (m).

`shape` `property`

Return the shape of the foundation footing.

`area()`

Area of circular footing (\(m^2\)).

`SquareFooting(width)`

Bases: FootingSize

A class representation of square footing.

PARAMETER	DESCRIPTION
`width`	Width of foundation footing (m). TYPE: `float`

METHOD	DESCRIPTION
`area`	Area of square footing (\(m^2\)).

ATTRIBUTE	DESCRIPTION
`width`	Width of foundation footing (m).
`length`	Width of foundation footing (m).
`shape`	Return the shape of the foundation footing. TYPE: `Shape`

`width` `property` `writable`

Width of foundation footing (m).

`length` `property` `writable`

Width of foundation footing (m).

`shape` `property`

Return the shape of the foundation footing.

`area()`

Area of square footing (\(m^2\)).

`RectangularFooting(width, length)`

Bases: FootingSize

A class representation of rectangular footing.

PARAMETER	DESCRIPTION
`width`	Width of foundation footing (m). TYPE: `float`
`length`	Length of foundation footing (m). TYPE: `float`

METHOD	DESCRIPTION
`area`	Area of rectangular footing (\(m^2\)).

ATTRIBUTE	DESCRIPTION
`width`	Width of foundation footing (m). TYPE: `float`
`length`	Length of foundation footing (m). TYPE: `float`
`shape`	Return the shape of the foundation footing. TYPE: `Shape`

`width` `property` `writable`

Width of foundation footing (m).

`length` `property` `writable`

Length of foundation footing (m).

`shape` `property`

Return the shape of the foundation footing.

`area()`

Area of rectangular footing (\(m^2\)).

`Foundation(depth, footing_size, eccentricity=0.0, load_angle=0.0, ground_water_level=inf, foundation_type=FoundationType.PAD)`

A simple class representing a foundation structure.

PARAMETER	DESCRIPTION
`depth`	Depth of foundation (m). TYPE: `float`
`footing_size`	Represents the size of the foundation footing. TYPE: `FootingSize`
`eccentricity`	The deviation of the foundation load from the center of gravity of the foundation footing (m). TYPE: `float` DEFAULT: `0.0`
`load_angle`	Inclination of the applied load with the vertical (\(\alpha^{\circ}\)) TYPE: `float` DEFAULT: `0.0`
`ground_water_level`	Depth of the water below ground level (m). TYPE: `Optional[float]` DEFAULT: `inf`
`foundation_type`	Type of foundation. TYPE: `FoundationType` DEFAULT: `PAD`

METHOD	DESCRIPTION
`foundation_area`	Returns the area of the foundation footing (\(m^2\)).
`footing_params`	Returns the `effective_width`, `length`, and `footing_shape`

ATTRIBUTE	DESCRIPTION
`depth`	Depth of foundation (m). TYPE: `float`
`width`	Width of foundation footing (m). TYPE: `float`
`length`	Length of foundation footing (m). TYPE: `float`
`footing_shape`	Shape of foundation footing. TYPE: `Shape`
`eccentricity`	The deviation of the foundation load from the center of TYPE: `float`
`load_angle`	Inclination of the applied load with the vertical. TYPE: `float`
`ground_water_level`	Depth of the water below ground level (m). TYPE: `Optional[float]`
`foundation_type`	Type of foundation. TYPE: `FoundationType`
`effective_width`	Returns the effective width of the foundation footing (m). TYPE: `float`

`depth` `property` `writable`

Depth of foundation (m).

`width` `property` `writable`

Width of foundation footing (m).

`length` `property` `writable`

Length of foundation footing (m).

`footing_shape` `property`

Shape of foundation footing.

`eccentricity` `property` `writable`

The deviation of the foundation load from the center of gravity of the foundation footing (m).

`load_angle` `property` `writable`

Inclination of the applied load with the vertical.

`ground_water_level` `property` `writable`

Depth of the water below ground level (m).

`foundation_type` `property` `writable`

Type of foundation.

`effective_width` `property`

Returns the effective width of the foundation footing (m).

`foundation_area()`

Returns the area of the foundation footing (\(m^2\)).

`footing_params()`

Returns the effective_width, length, and footing_shape of the foundation footing.

`create_foundation(depth, width, length=None, eccentricity=0.0, load_angle=0.0, ground_water_level=inf, foundation_type='pad', shape='square')`

A factory function that encapsulate the creation of a foundation.

PARAMETER	DESCRIPTION
`depth`	Depth of foundation (m). TYPE: `float`
`width`	Width of foundation footing. In the case of a circular footing, it refers to the footing diameter (m). TYPE: `float`
`length`	Length of foundation footing (m), defaults to None. TYPE: `Optional[float]` DEFAULT: `None`
`eccentricity`	The deviation of the foundation load from the center of gravity of the foundation footing (m), defaults to 0.0. This means that the foundation load aligns with the center of gravity of the foundation footing . TYPE: `float` DEFAULT: `0.0`
`load_angle`	Inclination of the applied load with the vertical (:math:`\alpha^{\circ}`). TYPE: `float` DEFAULT: `0.0`
`ground_water_level`	Depth of the water below ground level (m) TYPE: `Optional[float]` DEFAULT: `inf`
`foundation_type`	Type of foundation footing. TYPE: `FoundationType` DEFAULT: `'pad'`
`shape`	Shape of foundation footing TYPE: `Shape \| str` DEFAULT: `'square'`

RAISES	DESCRIPTION
`ValidationError`	Raised when length is not provided for a rectangular footing or an invalid shape is provided.

geolysis.foundation

Shape

STRIP = enum.auto() class-attribute instance-attribute

CIRCLE = enum.auto() class-attribute instance-attribute

SQUARE = enum.auto() class-attribute instance-attribute

RECTANGLE = enum.auto() class-attribute instance-attribute

FoundationType

PAD = enum.auto() class-attribute instance-attribute

ISOLATED = PAD class-attribute instance-attribute

MAT = enum.auto() class-attribute instance-attribute

RAFT = MAT class-attribute instance-attribute

FootingSize

shape property

StripFooting(width, length=inf)

width property writable

length property writable

shape property

area()

CircularFooting(diameter)

diameter property writable

width property writable

length property writable

shape property

area()

SquareFooting(width)

width property writable

length property writable

shape property

area()

RectangularFooting(width, length)

width property writable

length property writable

shape property

area()

Foundation(depth, footing_size, eccentricity=0.0, load_angle=0.0, ground_water_level=inf, foundation_type=FoundationType.PAD)

depth property writable

width property writable

length property writable

footing_shape property

eccentricity property writable

load_angle property writable

ground_water_level property writable

foundation_type property writable

effective_width property

foundation_area()

footing_params()

create_foundation(depth, width, length=None, eccentricity=0.0, load_angle=0.0, ground_water_level=inf, foundation_type='pad', shape='square')

`Shape`

`STRIP = enum.auto()` `class-attribute` `instance-attribute`

`CIRCLE = enum.auto()` `class-attribute` `instance-attribute`

`SQUARE = enum.auto()` `class-attribute` `instance-attribute`

`RECTANGLE = enum.auto()` `class-attribute` `instance-attribute`

`FoundationType`

`PAD = enum.auto()` `class-attribute` `instance-attribute`

`ISOLATED = PAD` `class-attribute` `instance-attribute`

`MAT = enum.auto()` `class-attribute` `instance-attribute`

`RAFT = MAT` `class-attribute` `instance-attribute`

`FootingSize`

`shape` `property`

`StripFooting(width, length=inf)`

`width` `property` `writable`

`length` `property` `writable`

`shape` `property`

`area()`

`CircularFooting(diameter)`

`diameter` `property` `writable`

`width` `property` `writable`

`length` `property` `writable`

`shape` `property`

`area()`

`SquareFooting(width)`

`width` `property` `writable`

`length` `property` `writable`

`shape` `property`

`area()`

`RectangularFooting(width, length)`

`width` `property` `writable`

`length` `property` `writable`

`shape` `property`

`area()`

`Foundation(depth, footing_size, eccentricity=0.0, load_angle=0.0, ground_water_level=inf, foundation_type=FoundationType.PAD)`

`depth` `property` `writable`

`width` `property` `writable`

`length` `property` `writable`

`footing_shape` `property`

`eccentricity` `property` `writable`

`load_angle` `property` `writable`

`ground_water_level` `property` `writable`

`foundation_type` `property` `writable`

`effective_width` `property`

`foundation_area()`

`footing_params()`

`create_foundation(depth, width, length=None, eccentricity=0.0, load_angle=0.0, ground_water_level=inf, foundation_type='pad', shape='square')`