com1DFA.debrisFunctions.releaseHydrograph
- releaseHydrograph(cfg, inputSimLines, particles, fields, dem, zPartArray0, t, atol=1e-05)[source]
Update particles with “new” particles initialised by a hydrograph.
- Parameters
cfg (configparser) – configuration settings
inputSimLines (dict) – dictionary with input data dictionaries (releaseLine, hydrographAreaLine,…)
particles (dict) – particles dictionary at t that are in the flow already
fields (dict) – fields dictionary at t
dem (dict) – dictionary with info on DEM data
zPartArray0 (dict) – dictionary containing z - value of particles at timestep 0
t (float) – timestep of iteration
atol (float) – look for matching time steps with atol tolerance - default is atol=1.e-5
- Returns
particles (dict) – particles dictionary at t including the hydrograph particles
fields (dict) – updated fields dictionary at t including the hydrograph particles
zPartArray0 (dict) – dictionary containing z - value of particles at timestep 0