Struct reservoirs::reservoir::Reservoir

pub struct Reservoir {
    pub mass: Vec<f64>,
    // some fields omitted
}

Struct for recording reservoir characteristics.

Fields

mass: Vec<f64>

Ages (in years) of deposits accumulated in reservoir.

Implementations

impl Reservoir

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

Compare the accumulated mass in a reservoir to another record. Produces two goodness-of-fit statistics in a tuple: the K-S statistic and the Kuiper statistic, respectively. Called by fit_rate, you can use it on individual records too.

Examples

use reservoirs::prelude::*;
fn main() -> Result<(), ResError> {
    let ages = vec![10.0, 42.0, 77.7, 12.0, 99.9, 10000.0, 777.7];
    let mut debris_flows = Reservoir::new()
        .input(&0.78)?
        .output(&0.78)?
        .sim(&4000.0)?;
    let fit = debris_flows.gof(&ages);
    println!("Fit is {:?}.", fit);
    Ok(())
}

pub fn inherit(self, ages: &[f64]) -> Self

Inherited age refers to age of charcoal upon entering the reservoir. Multiple samples of charcoal from a single deposit produces a vector of inherited ages, represented by the mean expected age of each charcoal sample in a f64 vector. The sample age of charcoal is the sum of its inherited age plus transit time through the reservoir. When simulating a reservoir model, each event entering the reservoir receives a random amount of inherited age sampled from the vector ages.

Examples

use reservoirs::prelude::*;
fn main() -> Result<(), ResError> {
    let start_ages = vec![7.0, 42.0, 401.0, 1234.5, 7777.7, 5.2, 0.1];
    let res = Reservoir::new().inherit(&start_ages);
    Ok(())
}

pub fn input(self, rate: &f64) -> Result<Self, ResError>

Assign an input rate to a reservoir. Converts a reference to a float 64 rate into an exponential distribution with lamdba rate using the rand crate.

Examples

use reservoirs::prelude::*;
fn main() -> Result<(), ResError> {
    // new reservoirs have no input rate, call input() to set one
    let mut res = Reservoir::new().input(&0.58)?;
    Ok(())
}

pub fn new() -> Self

Create reservoirs using a builder pattern. Calling new() creates an empty reservoir. Use the input and output methods to set rates, which start at None. Set inherited age similarly using the method inherit.

Examples

use reservoirs::prelude::*;
fn main() -> Result<(), ResError> {
    let mut res = Reservoir::new();
    Ok(())
}

pub fn output(self, rate: &f64) -> Result<Self, ResError>

Assign an output rate to a reservoir. Converts a reference to a float 64 rate into an exponential distribution with lamdba rate using the rand crate.

Examples

use reservoirs::prelude::*;
fn main() -> Result<(), ResError> {
    // new reservoirs have no output rate, call input() to set one
    let mut res = Reservoir::new().output(&0.58)?;
    Ok(())
}

pub fn range(self, seed: u64) -> Self

Assign a seed to the random number generator, for reproducibility.

• seed is a number to convert in an RNG seed using the rand crate.

Examples

use reservoirs::prelude::*;
fn main() -> Result<(), ResError> {
    // new reservoirs have a random seed, call range() to set a specific seed
    let mut res = Reservoir::new().range(10101);
    Ok(())
}

pub fn sim(self, period: &f64) -> Result<Self, ResError>

Workhorse function for simulating accumulation records in a reservoir. Runs simulations on reservoir objects created using the builder pattern. period specifies the amount of time to simulate accumulation in years. While generally this is a function called in series by other functions, you can use it to simulate a single accumulation record for a reservoir.

Examples

use reservoirs::prelude::*;
fn main () -> Result<(), ResError> {
    // create reservoirs
    let mut fines = Reservoir::new().input(&0.75)?.output(&0.75)?;
    let mut gravels = Reservoir::new().input(&0.54)?.output(&0.54)?;

    // simulate accumulation for 30000 years
    fines = fines.sim(&30000.0)?;
    gravels = gravels.sim(&30000.0)?;
    Ok(())
}

Trait Implementations

impl Clone for Reservoir

fn clone(&self) -> Reservoir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reservoir

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

Formats the value using the given formatter.

impl Default for Reservoir

fn default() -> Self

Returns the “default value” for a type.