out3Plot.outAna1Plots.plotDamBreakSummary

plotDamBreakSummary(avalancheDir, timeList, fieldsList, fieldHeader, solDam, hErrorL2Array, hErrorLMaxArray, vhErrorL2Array, vhErrorLMaxArray, outDirTest, simDFrow, simHash, cfg)[source]

Plot sumary figure of the damnreak test

Parameters

  • avalancheDir (pathlib path) – path to avalanche directory

  • timeList (list) – list of time steps

  • fieldsList (list) – list of fields dictionaries

  • timeList (list) – list of time steps

  • fieldHeader (dict) – header dictionary with info about the extend and cell size

  • solDam (dict) – analytic solution dictionary

  • fieldHeader (dict) – header dictionary with info about the extend and cell size

  • hErrorL2Array (numpy array) – L2 error on flow thickness for saved time steps

  • hErrorLMaxArray (numpy array) – LMax error on flow thickness for saved time steps

  • vErrorL2Array (numpy array) – L2 error on flow velocity for saved time steps

  • vErrorLMaxArray (numpy array) – LMax error on flow velocity for saved time steps

  • outDirTest (pathlib path) – path output directory (where to save the figures)

  • simDFrow (dataFrame) – data frame row corresponding to simHash

  • simHash (str) – com1DFA simulation id

  • cfg (configParser object) – configuration setting for avalanche simulation including DAMBREAK section