refactor(com1DFA): simplify resTypes handling and dataframe population

- Removed redundant condition for `resT` by excluding `FTDet` checks.
- Simplified logic to populate `resultsDF` unconditionally when appending new rows.

fix(com1DFA): correct timestep export condition for t=0

- Updated logic to use `np.any(dtSave <= 1.0e-8)` for handling initial timestep export.
- Removed redundant contour fetching logic for dummy fields

test(com1DFA): add unit test; squash

refactor(tests): fix `test_tSteps_output_behavior`

- Updated `com1DFA` to ensure particle directory initialization is handled conditionally during initial export.

refactor(com1DFA): ensure valid `resTypes` and improve contour fetching logic

- Added logic to append `pfv` to `resTypes` when it only contains invalid or insufficient field types (e.g., `particles` or empty).
- Adjusted contour line computation to skip when the target field is a dummy array.

refactor(com1DFA): simplify `resTypes` handling and remove redundant `resTypesLast`

- Replaced all instances of `resTypesLast` with `resTypes`
- Removed unused variable `resTypesLast` across the codebase.
- Ensured consistent use of `resTypes` for initializing fields and max value computations.

Author: fso42

avaframe/com1DFA/com1DFA.py

@@ -1658,7 +1658,11 @@ def initializeFields(cfg, dem, particles, releaseLine):
     cfgGen = cfg["GENERAL"]
     # what result types are desired as output (we need this to decide which fields we actually need to compute)
     resTypes = fU.splitIniValueToArraySteps(cfgGen["resType"])
-    resTypesLast = resTypes
+    # ensure at least one field type is present for internal computations
+    # if resTypes only contains particles add pfv
+    validFieldTypes = [rt for rt in resTypes if rt not in ["particles"]]
+    if len(validFieldTypes) == 0:
+        resTypes.append("pfv")
     # read dem header
     header = dem["header"]
     ncols = header["ncols"]
@@ -1683,7 +1687,7 @@ def initializeFields(cfg, dem, particles, releaseLine):
     fields["timeInfo"] = np.zeros((nrows, ncols))  # first time
     # for optional fields, initialize with dummys (minimum size array). The cython functions then need something
     # even if it is empty to run properly
-    if ("TA" in resTypesLast) or ("pta" in resTypesLast):
+    if ("TA" in resTypes) or ("pta" in resTypes):
         fields["pta"] = np.zeros((nrows, ncols))  # peak travel angle [°]
         fields["TA"] = np.zeros((nrows, ncols))  # travel angle [°]
         fields["computeTA"] = True
@@ -1692,14 +1696,14 @@ def initializeFields(cfg, dem, particles, releaseLine):
         fields["pta"] = np.zeros((1, 1))
         fields["TA"] = np.zeros((1, 1))
         fields["computeTA"] = False
-    if "pke" in resTypesLast:
+    if "pke" in resTypes:
         fields["pke"] = np.zeros((nrows, ncols))  # peak kinetic energy [kJ/m²]
         fields["computeKE"] = True
         log.debug("Computing Kinetic energy")
     else:
         fields["pke"] = np.zeros((1, 1))
         fields["computeKE"] = False
-    if ("P" in resTypesLast) or ("ppr" in resTypesLast):
+    if ("P" in resTypes) or ("ppr" in resTypes):
         fields["P"] = np.zeros((nrows, ncols))  # pressure [kPa]
         fields["ppr"] = np.zeros((nrows, ncols))  # peak pressure [kPa]
         fields["computeP"] = True
@@ -2037,8 +2041,11 @@ def DFAIterate(cfg, particles, fields, dem, inputSimLines, outDir, cuSimName, si
     # add particles to the results type if trackParticles option is activated
     if cfg.getboolean("TRACKPARTICLES", "trackParticles"):
         resTypes = list(set(resTypes + ["particles"]))
-    # use resTypes for all time steps
-    resTypesLast = resTypes
+    # ensure at least one field type is present for internal computations
+    # if resTypes only contains particles, add pfv
+    validFieldTypes = [rt for rt in resTypes if rt not in ["particles"]]
+    if len(validFieldTypes) == 0:
+        resTypes.append("pfv")
     # derive friction type
     # turn friction model into integer
     frictModelsList = [
@@ -2077,7 +2084,7 @@ def DFAIterate(cfg, particles, fields, dem, inputSimLines, outDir, cuSimName, si
     pfvTimeMax = []
 
     # setup a result fields info data frame to save max values of fields and avalanche front
-    resultsDF = setupresultsDF(resTypesLast, cfg["VISUALISATION"].getboolean("createRangeTimeDiagram"))
+    resultsDF = setupresultsDF(resTypes, cfg["VISUALISATION"].getboolean("createRangeTimeDiagram"))
 
     # Add different time stepping options here
     log.debug("Use standard time stepping")
@@ -2091,13 +2098,16 @@ def DFAIterate(cfg, particles, fields, dem, inputSimLines, outDir, cuSimName, si
     t = particles["t"]
     log.debug("Saving results for time step t = %f s", t)
 
+    # Initialize particles output directory if needed
+    if "particles" in resTypes:
+        outDirData = outDir / "particles"
+        fU.makeADir(outDirData)
+
     # export initial time step only if t=0 is explicitly in dtSave
-    if cfg["EXPORTS"].getboolean("exportData") and (dtSave.size > 0 and dtSave[0] <= 1.0e-8):
+    if cfg["EXPORTS"].getboolean("exportData") and (dtSave.size > 0 and np.any(dtSave <= 1.0e-8)):
         exportFields(cfg, t, fields, dem, outDir, cuSimName, TSave="initial")
 
         if "particles" in resTypes:
-            outDirData = outDir / "particles"
-            fU.makeADir(outDirData)
             savePartToPickle(particles, outDirData, cuSimName)
 
         # Update dtSave to remove the initial timestep we just saved
@@ -2129,7 +2139,7 @@ def DFAIterate(cfg, particles, fields, dem, inputSimLines, outDir, cuSimName, si
         cfgRangeTime["GENERAL"]["simHash"] = simHash
 
     # add initial time step to Tsave array only if it was exported
-    if dtSave.size > 0 and dtSave[0] <= 1.0e-8:
+    if dtSave.size > 0 and np.any(dtSave <= 1.0e-8):
         Tsave = [0]
     else:
         Tsave = []
@@ -2169,7 +2179,7 @@ def DFAIterate(cfg, particles, fields, dem, inputSimLines, outDir, cuSimName, si
             rangeValue = mtiInfo["rangeList"][-1]
         else:
             rangeValue = ""
-        resultsDF = addMaxValuesToDF(resultsDF, fields, t, resTypesLast, rangeValue=rangeValue)
+        resultsDF = addMaxValuesToDF(resultsDF, fields, t, resTypes, rangeValue=rangeValue)
 
         tCPU["nSave"] = nSave
         particles["t"] = t
@@ -2351,25 +2361,19 @@ def DFAIterate(cfg, particles, fields, dem, inputSimLines, outDir, cuSimName, si
         # export particles dictionaries of saving time steps
         if "particles" in resTypes:
             savePartToPickle(particles, outDirData, cuSimName)
-    else:
-        # fetch contourline info
+
+    # save contour line for each sim only if the field is properly computed (not a dummy array)
+    contourResType = cfg["VISUALISATION"]["contourResType"]
+    if fields[contourResType].shape != (1, 1):
         contourDictXY = outCom1DFA.fetchContCoors(
             dem["header"],
-            fields[cfg["VISUALISATION"]["contourResType"]],
+            fields[contourResType],
             cfg["VISUALISATION"],
             cuSimName,
         )
-
-    # save contour line for each sim
-    contourDictXY = outCom1DFA.fetchContCoors(
-        dem["header"],
-        fields[cfg["VISUALISATION"]["contourResType"]],
-        cfg["VISUALISATION"],
-        cuSimName,
-    )
-    outDirDataCont = outDir / "contours"
-    fU.makeADir(outDirDataCont)
-    saveContToPickle(contourDictXY, outDirDataCont, cuSimName)
+        outDirDataCont = outDir / "contours"
+        fU.makeADir(outDirDataCont)
+        saveContToPickle(contourDictXY, outDirDataCont, cuSimName)
 
     # export particles properties for visulation
     if cfg["VISUALISATION"].getboolean("writePartToCSV"):
@@ -2409,7 +2413,7 @@ def setupresultsDF(resTypes, cfgRangeTime):
     # TODO catch empty resTypes
     resDict = {"timeStep": [0.0]}
     for resT in resTypes:
-        if resT != "particles" and resT != "FTDet":
+        if resT != "particles":
             resDict["max" + resT] = [0.0]
     if cfgRangeTime:
         resDict["rangeList"] = [0.0]
@@ -2443,11 +2447,12 @@ def addMaxValuesToDF(resultsDF, fields, timeStep, resTypes, rangeValue=""):
 
     newLine = []
     for resT in resTypes:
-        if resT != "particles" and resT != "FTDet":
+        if resT != "particles":
             newLine.append(np.nanmax(fields[resT]))
 
     if rangeValue != "":
         newLine.append(rangeValue)
+
     resultsDF.loc[timeStep] = newLine
 
     return resultsDF
@@ -2980,6 +2985,11 @@ def exportFields(
         resTypesGen.remove("particles")
 
     resTypes = resTypesGen
+    # ensure at least one field type is present for export
+    # if resTypes only contains FTDet or is empty, add pfv
+    validFieldTypes = [rt for rt in resTypes if rt != "FTDet"]
+    if len(validFieldTypes) == 0:
+        resTypes.append("pfv")
 
     if resTypesForced != []:
         resTypes = resTypesForced

avaframe/log2Report/generateReport.py

@@ -203,7 +203,7 @@ def writeReport(outDir, reportDictList, reportOneFile, plotDict='', standaloneRe
             # Loop through all simulations
             for reportD in reportDictList:
 
-                if plotDict != '' and ('simName' in reportD):
+                if plotDict != '' and ('simName' in reportD) and (reportD['simName']['name'] in plotDict):
                     # add plot info to general report Dict
                     reportD['Simulation Results'] = plotDict[reportD['simName']['name']]
                     reportD['Simulation Results'].update({'type': 'image'})
@@ -222,7 +222,7 @@ def writeReport(outDir, reportDictList, reportOneFile, plotDict='', standaloneRe
         # Loop through all simulations
         for reportD in reportDictList:
 
-            if plotDict != '':
+            if plotDict != '' and (reportD['simName']['name'] in plotDict):
                 # add plot info to general report Dict
                 reportD['Simulation Results'] = plotDict[reportD['simName']['name']]
                 reportD['Simulation Results'].update({'type': 'image'})

avaframe/tests/test_com1DFA.py

@@ -2926,10 +2926,9 @@ def test_adaptDEM():
     assert np.all(fieldsAdapted["sfcChangeTotal"] == fields["FTDet"] / NzNormed)
 
 
-def test_tSteps_output_behavior(tmp_path):
+def test_tSteps_output_behavior(tmp_path, caplog):
     """Test that tSteps controls which timesteps are exported correctly.
 
-    New behavior:
     - Empty tSteps (default): only final timestep is exported
     - Explicit tSteps with t=0: t=0 timestep is exported
     """
@@ -2941,31 +2940,19 @@ def test_tSteps_output_behavior(tmp_path):
     shutil.copytree(inputDir, avaDir1)
     cfgFile1 = avaDir1 / "test_com1DFACfg.ini"
 
+    # Get main configuration
+    cfgMain = cfgUtils.getGeneralConfig()
+    cfgMain['MAIN']['avalancheDir'] = str(avaDir1)
     # Modify config to have empty tSteps and NO parameter variations
-    cfg = configparser.ConfigParser()
-    cfg.read(cfgFile1)
+    cfg = cfgUtils.getModuleConfig(com1DFA, cfgFile1)
     cfg["GENERAL"]["tSteps"] = ""
     cfg["GENERAL"]["tEnd"] = "10"  # Short simulation
     cfg["GENERAL"]["dt"] = "0.1"  # Single value, no variations
     cfg["GENERAL"]["simTypeList"] = "null"  # Simple simulation, no entrainment/resistance
-    # Ensure exports are enabled
-    if "EXPORTS" not in cfg:
-        cfg["EXPORTS"] = {}
-    cfg["EXPORTS"]["exportData"] = "True"
     with open(cfgFile1, "w") as f:
         cfg.write(f)
 
-    cfgMain1 = configparser.ConfigParser()
-    cfgMain1["MAIN"] = {"avalancheDir": str(avaDir1), "nCPU": "1"}
-    cfgMain1["FLAGS"] = {
-        "showPlot": "False",
-        "savePlot": "False",
-        "ReportDir": "False",
-        "reportOneFile": "False",
-        "debugPlot": "False",
-    }
-
-    dem, plotDict, reportDictList, simDF = com1DFA.com1DFAMain(cfgMain1, cfgInfo=cfgFile1)
+    dem, plotDict, reportDictList, simDF = com1DFA.com1DFAMain(cfgMain, cfgInfo=cfgFile1)
 
     # Check that only final timestep files exist in timeSteps directory
     timeStepsDir1 = avaDir1 / "Outputs" / "com1DFA" / "peakFiles" / "timeSteps"
@@ -2981,37 +2968,49 @@ def test_tSteps_output_behavior(tmp_path):
     shutil.copytree(inputDir, avaDir2)
     cfgFile2 = avaDir2 / "test_com1DFACfg.ini"
 
+    cfgMain['MAIN']['avalancheDir'] = str(avaDir2)
+
     # Modify config to have explicit tSteps including t=0 and NO parameter variations
-    cfg2 = configparser.ConfigParser()
-    cfg2.read(cfgFile2)
+    cfg2 = cfgUtils.getModuleConfig(com1DFA, cfgFile2)
     cfg2["GENERAL"]["tSteps"] = "0|5"
     cfg2["GENERAL"]["tEnd"] = "10"  # Short simulation
     cfg2["GENERAL"]["dt"] = "0.1"  # Single value, no variations
     cfg2["GENERAL"]["simTypeList"] = "null"  # Simple simulation, no entrainment/resistance
-    # Ensure exports are enabled
-    if "EXPORTS" not in cfg2:
-        cfg2["EXPORTS"] = {}
-    cfg2["EXPORTS"]["exportData"] = "True"
     with open(cfgFile2, "w") as f:
         cfg2.write(f)
 
-    cfgMain2 = configparser.ConfigParser()
-    cfgMain2["MAIN"] = {"avalancheDir": str(avaDir2), "nCPU": "1"}
-    cfgMain2["FLAGS"] = {
-        "showPlot": "False",
-        "savePlot": "False",
-        "ReportDir": "False",
-        "reportOneFile": "False",
-        "debugPlot": "False",
-    }
-
-    dem2, plotDict2, reportDictList2, simDF2 = com1DFA.com1DFAMain(cfgMain2, cfgInfo=cfgFile2)
+    dem2, plotDict2, reportDictList2, simDF2 = com1DFA.com1DFAMain(cfgMain, cfgInfo=cfgFile2)
 
     # Check that t=0 timestep files exist
     timeStepsDir2 = avaDir2 / "Outputs" / "com1DFA" / "peakFiles" / "timeSteps"
     assert timeStepsDir2.exists(), "timeSteps directory should exist"
-    allFiles2 = list(timeStepsDir2.glob("*.asc"))
-    print(f"\nAll timestep files: {[f.name for f in allFiles2]}")
     tStepFiles2 = list(timeStepsDir2.glob("*_t0.0*.asc"))
-    print(f"Files matching t0.0: {[f.name for f in tStepFiles2]}")
     assert len(tStepFiles2) > 0, "Should have initial timestep files at t=0 when tSteps includes 0"
+
+    # Test 3: exportData = False should trigger contour fetching in else block
+    avaDir3 = pathlib.Path(tmp_path, "testExportDataFalse")
+    shutil.copytree(inputDir, avaDir3)
+    cfgFile3 = avaDir3 / "test_com1DFACfg.ini"
+
+    cfgMain['MAIN']['avalancheDir'] = str(avaDir3)
+
+    # Modify config to have exportData = False
+    cfg3 = cfgUtils.getModuleConfig(com1DFA, cfgFile3)
+    cfg3["GENERAL"]["tSteps"] = ""
+    cfg3["GENERAL"]["tEnd"] = "5"  # Very short simulation
+    cfg3["GENERAL"]["dt"] = "0.1"
+    cfg3["GENERAL"]["simTypeList"] = "null"
+    cfg3["EXPORTS"]["exportData"] = "False"  # Key setting to test else block
+    with open(cfgFile3, "w") as f:
+        cfg3.write(f)
+
+    dem3, plotDict3, reportDictList3, simDF3 = com1DFA.com1DFAMain(cfgMain, cfgInfo=cfgFile3)
+
+    # Check that contour data was generated (stored in reportDict) instead of exported files
+    assert len(reportDictList3) > 0, "Should have report dict even with exportData=False"
+    # Verify that timeSteps directory doesn't exist (no data exported)
+    timeStepsDir3 = avaDir3 / "Outputs" / "com1DFA" / "peakFiles" / "timeSteps"
+    if timeStepsDir3.exists():
+        tStepFiles3 = list(timeStepsDir3.glob("*.asc"))
+        # With exportData=False, intermediate timesteps should not be exported
+        assert len(tStepFiles3) == 0, "No timestep files should be exported when exportData=False"