# MonteCarloResult

Monte Carlo realizations of the long-term capacity.

Usage

[Source](https://github.com/lornearnold/driven-pile/blob/main/src/driven_pile/results.py#L177-L247)

``` python
MonteCarloResult(
    ltc,
    shaft,
    toe_eod,
    bias,
    dphi,
    crr_multiplier,
    top_phi,
    elevation,
    phi_quantiles,
    converged,
    percentiles=(5, 25, 50, 75, 95),
)
```

## Attributes

`ltc: ndarray`  
Long-term capacity per realization, kips.

`shaft: ndarray`  
Long-term shaft resistance per realization, kips.

`toe_eod: ndarray`  
End-of-drive toe resistance per realization, kips.

`bias: ndarray`  
Capacity-formula bias drawn per realization.

`dphi: ndarray`  
Shift of the friction angle correlation line drawn per realization, deg.

`crr_multiplier: ndarray`  
Multiplier on the cyclic resistance ratio drawn per realization.

`top_phi: ndarray`  
Top-segment friction angle drawn per realization, deg.

`elevation: ndarray`  
Elevation of each foot of the analysis grid, ft.

`phi_quantiles: ndarray`  
Friction angle percentiles 5, 25, 50, 75 and 95 per foot, shape `(n_feet, 5)`.

`converged: bool`  
True if the stopping criterion was met before the realization limit.

## Attributes

| Name    | Description             |
|---------|-------------------------|
| [n](#n) | Number of realizations. |

### n

Number of realizations.

`n: int`

## Methods

| Name | Description |
|----|----|
| [mean_ci()](#mean_ci) | Mean long-term capacity and its confidence half-width, kips. |
| [plot_ltc()](#plot_ltc) | Plot the distribution of long-term capacity. |
| [quantiles()](#quantiles) | Quantiles of the long-term capacity. |

### mean_ci()

Mean long-term capacity and its confidence half-width, kips.

Usage

[Source](https://github.com/lornearnold/driven-pile/blob/main/src/driven_pile/results.py#L238-L241)

``` python
mean_ci(z=1.96)
```

### plot_ltc()

Plot the distribution of long-term capacity.

Usage

[Source](https://github.com/lornearnold/driven-pile/blob/main/src/driven_pile/results.py#L243-L247)

``` python
plot_ltc(ax=None)
```

### quantiles()

Quantiles of the long-term capacity.

Usage

[Source](https://github.com/lornearnold/driven-pile/blob/main/src/driven_pile/results.py#L223-L236)

``` python
quantiles(q)
```

#### Parameters

`q: float or array_like`  
Probabilities in \[0, 1\].

#### Returns

`ndarray`  
Capacity at each probability, kips.