pyDeltaRCM.sed_tools.SandRouter

class pyDeltaRCM.sed_tools.SandRouter(*args, **kwargs)

Jitted class to route sand.

Initialized in init_sediment_routers with a multitude of constants. The Router is then called via the public run method in the sed_route method.

Important

A new Router must be initialized if any constants are changed to the underlying DeltaModel object. Convention is to call init_sediment_routers in any property setter.

__init__(_dt, dx, Vp_sed, u_max, qs0, u0, U_ero_sand, f_bedload, ivec_flat, jvec_flat, iwalk_flat, jwalk_flat, distances_flat, dry_depth, beta, stepmax, theta_sed)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(_dt, dx, Vp_sed, u_max, qs0, u0, …)

Initialize self.

run(start_indices, eta, stage, depth, …)

The main function to route and deposit/erode sand parcels.

Attributes

class_type