Struct reservoirs::reservoir::Fluvial

pub struct Fluvial { /* fields omitted */ }

Fluvial traversal struct for gravels and fines.

Implementations

impl Fluvial

pub fn new() -> Fluvial

New fluvial struct

pub fn cherry_pick(self) -> Vec<f64>

Cherry pick the closest fit to an observed distribution.

pub fn hit_rate(self) -> Vec<f64>

Hit rate for statistical thresholds.

pub fn hit_rates(self) -> FluvialFit

Fits a given flux probability and storage rate to an empiric record.

pub fn hit_rates_timed(self, path: &str) -> Result<Vec<FluvialFit>, ResError>

Run fit_rates() for a set duration.

pub fn fit(self, other: &[f64]) -> Vec<f64>

Fit number of runs to gof tests and return mean of each.

pub fn fit_rate(self, other: &[f64]) -> FluvialFit

Fits a given flux probability and storage rate to an empiric record.

pub fn stereotype_rate(self) -> Vec<f64>

Return a stereotypical mass age distribution at the current model parameters.

pub fn fit_rates(self, other: &[f64]) -> Vec<FluvialFit>

Fit a range of flux probabilities and storage rates to an empiric record.

pub fn fit_rates_timed(
    self,
    other: &[f64],
    path: &str
) -> Result<Vec<FluvialFit>, ResError>

Run fit_rates() for a set duration.

pub fn capture_rate_fines(self, capture_rate_fines: f64) -> Self

Represents the probability of fines routing to the storage pool.

pub fn capture_rate_gravels(self, capture_rate_gravels: f64) -> Self

Represents the probability of gravels routing to the storage pool.

pub fn gof(self, other: &[f64]) -> Vec<f64>

Goodness-of-fit test suite.

pub fn manager(self, manager: &ModelManager) -> Self

Assign ModelManager to Fluvial struct

pub fn n_sim(self) -> Vec<f64>

Runs sim() a number of times specified by ModelManager struct.

pub fn record_mass(self, path: &str) -> Result<(), ResError>

Prints csv of reservoir mass to file path.

pub fn sim(self) -> Self

Simulates removal from the reservoir over time based on the rate.

pub fn source(self, source: Vec<f64>) -> Self

Sets source flux for reservoirs.

pub fn source_from_csv(self, path: &str) -> Result<Self, ResError>

Sets source flux from csv. To save and reuse large samples that are computationally intensive.

pub fn storage_rate_fines(self, storage_rate_fines: f64) -> Self

Sets the rate of the Poisson distribution defining the PMF of storage time for fines.

pub fn storage_rate_gravels(self, storage_rate_gravels: f64) -> Self

Sets the rate of the Poisson distribution defining the PMF of storage time for fines.

pub fn transit_times(self) -> Vec<f64>

Return CDF of transit times based on model parameters.

pub fn turnover(self, turnover: &f64) -> Self

Sets length of the turnover period.

Trait Implementations

impl Clone for Fluvial

fn clone(&self) -> Fluvial

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Fluvial

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Fluvial

fn default() -> Fluvial

Returns the “default value” for a type.