settle: Calculate settling velocity for a particle.

Description Usage Arguments Value Examples

View source: R/settle.r

Description

settle calculates the settling velocity for a particle, given some parameters.

Usage

1
settle(ws_mode, D, constants)

Arguments

ws_mode

Denotes whether to use a 'simple' equation, neglecting the shape and roundness of particles, or to use the more 'complex' formulation

D

The grain size you wish to calculate settling velocity for.

constants

A list of constants for calculation, need in order (g) gravitational constant, (rhos) sediment density, (rhof) fluid density, (nuu) kinematic viscosity, (csf) corey shape factor, and (PI) Powers roundness index. For the simple formulation, neglect the last two. Defaults to constants = list(g = 9.8, rhos = 2650, rhof = 1000, nuu = 1.004e-6, csf = 0.7, PI = 3.5)

Value

Returns a list with two values $ws and $wstar which are the settling velocity and dimensionless settling velocity, respectively.

Examples

1
2
settle('simple', 120e-6)
settle('complex', 120e-6, list(g = 9.8, rhos = 2650, rhof = 1000, nuu  = 1.004e-6, csf = 0.7, PI = 3.5)

ericbarefoot/barefootr documentation built on May 3, 2019, 8:33 p.m.