# Pile

Pile geometry and stiffness.

Usage

[Source](https://github.com/lornearnold/driven-pile/blob/main/src/driven_pile/inputs.py#L85-L129)

``` python
Pile(
    area,
    perimeter,
    width,
    length,
    modulus,
)
```

## Attributes

`area: float`  
Cross-sectional area, ft^2.

`perimeter: float`  
Perimeter, ft.

`width: float`  
Width across flats (or diameter), ft.

`length: float`  
Total pile length, ft.

`modulus: float`  
Elastic modulus of the pile material, ksf.

## Methods

| Name | Description |
|----|----|
| [octagonal()](#octagonal) | Regular octagonal section from its width across flats in inches. |
| [round()](#round) | Solid circular section from its diameter in inches. |
| [square()](#square) | Square section from its side in inches. |

### octagonal()

Regular octagonal section from its width across flats in inches.

Usage

[Source](https://github.com/lornearnold/driven-pile/blob/main/src/driven_pile/inputs.py#L109-L116)

``` python
octagonal(
    width_in,
    length_ft,
    modulus_ksf=864000.0,
)
```

### round()

Solid circular section from its diameter in inches.

Usage

[Source](https://github.com/lornearnold/driven-pile/blob/main/src/driven_pile/inputs.py#L124-L129)

``` python
round(
    diameter_in,
    length_ft,
    modulus_ksf=864000.0,
)
```

### square()

Square section from its side in inches.

Usage

[Source](https://github.com/lornearnold/driven-pile/blob/main/src/driven_pile/inputs.py#L118-L122)

``` python
square(
    width_in,
    length_ft,
    modulus_ksf=864000.0,
)
```