com1DFA.com1DFA.initializeSimulation

initializeSimulation(cfg, outDir, demOri, inputSimLines, logName)[source]

create simulaton report dictionary

Parameters

  • cfg (str) – simulation scenario name

  • outDir (pathlib path) – path to output directory (to save the dam foot line if a dam is used)

  • demOri (dict) – dictionary with original dem

  • inputSimLines (dict) –

    releaseLinedict

    release line dictionary

    releaseLineBuffer: dict

    release line buffer dictionary - optional if iniStep True

    secondaryReleaseLinedict

    secondary release line dictionary

    entLinedict

    entrainment line dictionary

    resLinedict

    resistance line dictionary

  • logName (str) – simulation scenario name

Returns

  • particles (dict) – particles dictionary at initial time step list of secondary release particles to be used

  • fields (dict) – fields dictionary at initial time step

  • dem (dict) – dictionary with new dem (lower left center at origin)