Struct reservoirs::reservoir::ModelManager

pub struct ModelManager { /* fields omitted */ }

Model manager struct for control flow of modeling operations.

Implementations

impl ModelManager

Methods for modeling.

pub fn new() -> ModelManager

Reference a FluvialModel type to create a new ModelManager instance.

pub fn batch(self, batch: usize) -> Self

Set the batch size for runs.

pub fn capture_fines(self, capture_fines: Range<f64>) -> Self

Set capture rate of fines.

pub fn capture_gravels(self, capture_gravels: Range<f64>) -> Self

Set capture rate of gravels.

pub fn duration(self, duration: u64) -> Self

Set duration of timed runs.

pub fn fines(self, fines: bool) -> Self

Set to true to produce fines with Fluvial::sim().

pub fn index(self, index: Range<i32>) -> Self

Set the index range for transit_times().

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

Set period length of model runs.

pub fn obs_len(self, obs: &[f64]) -> Self

Set number of observations to collect for representative sample.

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

Set period length of model runs.

pub fn periods(self, periods: Range<f64>) -> Self

Set the period range for Reservoir::fit_rates().

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

Set model seed.

pub fn rates(self, rates: Range<f64>) -> Self

Set the range of input/output rates for Reservoir::fit_rates().

pub fn runs(self, runs: usize) -> Self

Set number of model runs.

pub fn seed_clones(self) -> Vec<ModelManager>

Return a vector of struct clones with unique but reproducible seeds.

pub fn source_runs(self, source_runs: usize) -> Self

Set the number of runs when estimating source mass (per run of Fluvial::sim()).

pub fn storage_fines(self, storage_fines: Range<f64>) -> Self

Set the range of storage rates for fines.

pub fn storage_gravels(self, storage_gravels: Range<f64>) -> Self

Set the range of storage rates for gravels.

pub fn thresholds(self, ad: f64, ch: f64, kp: f64, ks: f64) -> Self

Set statistical thresholds for goodness-of-fit tests.

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

Set the range of turnover periods for sediment storage.

Trait Implementations

impl Clone for ModelManager

fn clone(&self) -> ModelManager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModelManager

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

Formats the value using the given formatter.

impl Default for ModelManager

fn default() -> ModelManager

Returns the “default value” for a type.