replace "output_frequency" with "output_interval" for post-processing in tests (#1686)

mbkuhn · web-flow · commit 7346fd2a99e5 · 2025-07-09T11:46:45.000-06:00
diff --git a/docs/sphinx/user/amr_wind_inputs.txt b/docs/sphinx/user/amr_wind_inputs.txt
@@ -109,7 +109,7 @@ nodal_proj.mg_atol                          = 1.0e-12
 incflo.post_processing = sampling enstrophy ke
 
 # Data probe sampling
-sampling.output_frequency = 1
+sampling.output_interval = 1
 sampling.labels = l_v11 p_h
 sampling.fields = velocity temperature
 
@@ -130,6 +130,6 @@ sampling.p_h.offsets = 0.0 50.0 150.0
 
 # kinetic energy and enstrophy integration
 ke.type = KineticEnergy
-ke.output_frequency = 1
+ke.output_interval = 1
 enstrophy.type = Enstrophy
-enstrophy.output_frequency = 1
+enstrophy.output_interval = 1
diff --git a/docs/sphinx/user/inputs_Enstrophy.rst b/docs/sphinx/user/inputs_Enstrophy.rst
@@ -14,7 +14,7 @@ The prefix is the label set in ``incflo.post_processing``. For example
 
    To use enstrophy output specify with keyword ``Enstrophy``
    
-.. input_param:: enst.output_frequency
+.. input_param:: enst.output_interval
 
    **type:** Integer, optional, default = 10
 
diff --git a/docs/sphinx/user/inputs_KineticEnergy.rst b/docs/sphinx/user/inputs_KineticEnergy.rst
@@ -14,7 +14,7 @@ The prefix is the label set in ``incflo.post_processing``. For example
 
     To use kinetic energy post processing specify with keyword ``KineticEnergy``
 
-.. input_param:: ke.output_frequency
+.. input_param:: ke.output_interval
 
    **type:** Integer, optional, default = 10
 
diff --git a/docs/sphinx/walkthrough/calibrate_inp.txt b/docs/sphinx/walkthrough/calibrate_inp.txt
@@ -91,7 +91,7 @@ Actuator.T0.use_root_correction          = true
 #---- postprocessing defs ----
 incflo.post_processing                   = sampling            
 sampling.type                            = Sampling            
-sampling.output_frequency                = 100                 
+sampling.output_interval                = 100                 
 sampling.fields                          = velocity            
 
 #---- sample defs ----
diff --git a/docs/sphinx/walkthrough/precursor_inp.txt b/docs/sphinx/walkthrough/precursor_inp.txt
@@ -69,7 +69,7 @@ ABL.surface_temp_flux                    = 0.05  # Surface temperature flux [K-m
 incflo.post_processing                   = sampling averaging
 
 # --- Sampling parameters ---
-sampling.output_frequency                = 96
+sampling.output_interval                = 96
 sampling.fields                          = velocity temperature
 
 #---- sample defs ----
diff --git a/docs/sphinx/walkthrough/spinup_inp.txt b/docs/sphinx/walkthrough/spinup_inp.txt
@@ -62,7 +62,7 @@ ABL.surface_temp_flux                    = 0.05  # Surface temperature flux [K-m
 incflo.post_processing                   = sampling
 
 # --- Sampling parameters ---
-sampling.output_frequency                = 900
+sampling.output_interval                = 900
 sampling.fields                          = velocity temperature
 
 #---- sample defs ----
diff --git a/docs/sphinx/walkthrough/turbines_inp.txt b/docs/sphinx/walkthrough/turbines_inp.txt
@@ -89,7 +89,7 @@ ABLMeanBoussinesq.temperature_profile_filename = avg_theta.dat
 incflo.post_processing                   = sampling averaging
 
 # --- Sampling parameters ---
-sampling.output_frequency                = 100
+sampling.output_interval                = 100
 sampling.fields                          = velocity temperature
 
 #---- sample defs ----
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -153,7 +153,7 @@ endfunction(add_test_u)
 # Add test that also checks post-processing scripts: sampling
 function(add_test_pps TEST_NAME FORMAT NINT NSTEPS)
     setup_test()
-    set(ADDL_RUNTIME_OPTIONS "sampling.output_format=${FORMAT} sampling.output_frequency=${NINT} time.plot_interval=-1 time.checkpoint_interval=-1 time.max_step=${NSTEPS}")
+    set(ADDL_RUNTIME_OPTIONS "sampling.output_format=${FORMAT} sampling.output_interval=${NINT} time.plot_interval=-1 time.checkpoint_interval=-1 time.max_step=${NSTEPS}")
     add_test("${TEST_NAME}_sampling_${FORMAT}" bash -c "set -o pipefail && ${MPI_COMMANDS} ${CMAKE_BINARY_DIR}/${amr_wind_exe_name} ${MPIEXEC_POSTFLAGS} ${CURRENT_TEST_BINARY_DIR}/${TEST_NAME}.inp ${RUNTIME_OPTIONS} ${ADDL_RUNTIME_OPTIONS} 2>&1 | tee ${TEST_NAME}_sampling_${FORMAT}.log && ${Python3_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/sampling_${TEST_NAME}_${FORMAT}.py")
     # Set properties for test
     set_tests_properties("${TEST_NAME}_sampling_${FORMAT}" PROPERTIES
diff --git a/test/test_files/abl_godunov_ascent/abl_godunov_ascent.inp b/test/test_files/abl_godunov_ascent/abl_godunov_ascent.inp
@@ -77,4 +77,4 @@ incflo.verbose          =   0          # incflo_level
 incflo.post_processing = ascent
 ascent.type = Ascent
 ascent.fields = p temperature
-ascent.output_frequency = 5
+ascent.output_interval = 5
diff --git a/test/test_files/abl_sampling/abl_sampling.inp b/test/test_files/abl_sampling/abl_sampling.inp
@@ -89,7 +89,7 @@ incflo.verbose          =   0          # incflo_level
 #               SAMPLING                #
 #.......................................#
 incflo.post_processing       = volume_sampling volume_sampling2 probe_sampling plane_sampling line_sampling
-volume_sampling.output_frequency    = 1
+volume_sampling.output_interval    = 1
 volume_sampling.output_format       = native
 volume_sampling.fields              = velocity
 volume_sampling.int_fields          = mask_cell
@@ -104,7 +104,7 @@ volume_sampling.volume2.lo          = 205.0 200.0 200.0
 volume_sampling.volume2.hi          = 505.0 500.0 500.0
 volume_sampling.volume2.num_points  = 30 10 10
 
-volume_sampling2.output_frequency    = 1
+volume_sampling2.output_interval    = 1
 volume_sampling2.output_format       = native
 volume_sampling2.fields              = velocity
 volume_sampling2.int_fields          = mask_cell
@@ -115,7 +115,7 @@ volume_sampling2.volume1.lo          = 20.0 20.0 20.0
 volume_sampling2.volume1.hi          = 50.0 50.0 50.0
 volume_sampling2.volume1.num_points  = 5 5 5
 
-probe_sampling.output_frequency    = 1
+probe_sampling.output_interval    = 1
 probe_sampling.output_format       = native
 probe_sampling.fields              = velocity
 probe_sampling.int_fields          = mask_cell
@@ -125,7 +125,7 @@ probe_sampling.probe1.probe_location_file = "probe_locations.txt"
 probe_sampling.probe1.offset_vector = 0.0 1.0 1.0
 probe_sampling.probe1.offsets   = 0.0 200.0 400.0 600.0
 
-plane_sampling.output_frequency     = 1
+plane_sampling.output_interval     = 1
 plane_sampling.output_format        = native
 plane_sampling.fields               = velocity
 plane_sampling.labels               = plane1 plane2 plane3
@@ -153,7 +153,7 @@ plane_sampling.plane3.num_points    = 10 10
 plane_sampling.plane3.offset_vector = 0.0 1.0 1.0
 plane_sampling.plane3.offsets       = 0.0 20.0 30.0 200.0
 
-line_sampling.output_frequency     = 1
+line_sampling.output_interval     = 1
 line_sampling.output_format        = native
 line_sampling.fields               = velocity
 line_sampling.labels               = line1
diff --git a/test/test_files/abl_sampling_netcdf/abl_sampling_netcdf.inp b/test/test_files/abl_sampling_netcdf/abl_sampling_netcdf.inp
@@ -89,7 +89,7 @@ incflo.verbose          =   0          # incflo_level
 #               SAMPLING                #
 #.......................................#
 incflo.post_processing       = volume_sampling volume_sampling2 probe_sampling plane_sampling line_sampling
-volume_sampling.output_frequency    = 1
+volume_sampling.output_interval    = 1
 volume_sampling.output_format       = netcdf
 volume_sampling.fields              = velocity
 volume_sampling.int_fields          = mask_cell
@@ -104,7 +104,7 @@ volume_sampling.volume2.lo          = 205.0 200.0 200.0
 volume_sampling.volume2.hi          = 505.0 500.0 500.0
 volume_sampling.volume2.num_points  = 30 10 10
 
-volume_sampling2.output_frequency    = 1
+volume_sampling2.output_interval    = 1
 volume_sampling2.output_format       = netcdf
 volume_sampling2.fields              = velocity
 volume_sampling2.int_fields          = mask_cell
@@ -115,7 +115,7 @@ volume_sampling2.volume1.lo          = 20.0 20.0 20.0
 volume_sampling2.volume1.hi          = 50.0 50.0 50.0
 volume_sampling2.volume1.num_points  = 5 5 5
 
-probe_sampling.output_frequency    = 1
+probe_sampling.output_interval    = 1
 probe_sampling.output_format       = netcdf
 probe_sampling.fields              = velocity
 probe_sampling.int_fields          = mask_cell
@@ -125,7 +125,7 @@ probe_sampling.probe1.probe_location_file = "probe_locations.txt"
 probe_sampling.probe1.offset_vector = 0.0 1.0 1.0
 probe_sampling.probe1.offsets   = 0.0 200.0 400.0 600.0
 
-plane_sampling.output_frequency     = 1
+plane_sampling.output_interval     = 1
 plane_sampling.output_format        = netcdf
 plane_sampling.fields               = velocity
 plane_sampling.labels               = plane1 plane2 plane3
@@ -153,7 +153,7 @@ plane_sampling.plane3.num_points    = 10 10
 plane_sampling.plane3.offset_vector = 0.0 1.0 1.0
 plane_sampling.plane3.offsets       = 0.0 20.0 30.0 200.0
 
-line_sampling.output_frequency     = 1
+line_sampling.output_interval     = 1
 line_sampling.output_format        = netcdf
 line_sampling.fields               = velocity
 line_sampling.labels               = line1
diff --git a/test/test_files/abl_virtual_lidar/abl_virtual_lidar.inp b/test/test_files/abl_virtual_lidar/abl_virtual_lidar.inp
@@ -52,7 +52,7 @@ ABL.surface_roughness_z0 = 0.15
 #
 incflo.post_processing = sampling
 sampling.output_format= netcdf
-sampling.output_frequency = 1
+sampling.output_interval = 1
 sampling.labels = lidar spinner
 sampling.fields = velocity
 
diff --git a/test/test_files/channel_mosd/channel_mosd.inp b/test/test_files/channel_mosd/channel_mosd.inp
@@ -20,7 +20,7 @@ io.output_hdf5_plotfile       =  true
 
 incflo.post_processing = averaging ke
 ke.type                    = KineticEnergy
-ke.output_frequency        = 100
+ke.output_interval        = 100
 averaging.type = TimeAveraging
 averaging.labels = means stress
 averaging.averaging_window = 10.0              # this is seconds of simulation
diff --git a/test/test_files/dam_break_godunov/dam_break_godunov.inp b/test/test_files/dam_break_godunov/dam_break_godunov.inp
@@ -8,7 +8,7 @@ time.plot_interval            =  10       # Steps between plot files
 time.checkpoint_interval      =  -100       # Steps between checkpoint files
 
 incflo.post_processing        = sampling
-sampling.output_frequency     = 10
+sampling.output_interval     = 10
 sampling.output_format        = native
 sampling.labels               = fs
 sampling.fields               = velocity
diff --git a/test/test_files/fat_cored_vortex_ring/fat_cored_vortex_ring.inp b/test/test_files/fat_cored_vortex_ring/fat_cored_vortex_ring.inp
@@ -19,9 +19,9 @@ io.outputs = vorticity
 io.derived_outputs = q_criterion q_criterion_nondim mag_vorticity
 incflo.post_processing = ke enst
 ke.type = KineticEnergy
-ke.output_frequency = 1
+ke.output_interval = 1
 enst.type = Enstrophy
-enst.output_frequency = 1
+enst.output_interval = 1
 
 #¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨#
 #               PHYSICS                 #
diff --git a/test/test_files/tgv_godunov/tgv_godunov.inp b/test/test_files/tgv_godunov/tgv_godunov.inp
@@ -18,9 +18,9 @@ time.checkpoint_interval =   -1  # Steps between checkpoint files
 
 incflo.post_processing = enstrophy ke
 ke.type = KineticEnergy
-ke.output_frequency = 1
+ke.output_interval = 1
 enstrophy.type = Enstrophy
-enstrophy.output_frequency = 1
+enstrophy.output_interval = 1
 #¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨#
 #               PHYSICS                 #
 #.......................................#
diff --git a/test/test_files/vortex_dipole_inout_refine/vortex_dipole_inout_refine.inp b/test/test_files/vortex_dipole_inout_refine/vortex_dipole_inout_refine.inp
@@ -18,9 +18,9 @@ time.checkpoint_interval =   -1  # Steps between checkpoint files
 
 incflo.post_processing = enstrophy ke
 ke.type = KineticEnergy
-ke.output_frequency = 1
+ke.output_interval = 1
 enstrophy.type = Enstrophy
-enstrophy.output_frequency = 1
+enstrophy.output_interval = 1
 
 io.derived_outputs = q_criterion mag_vorticity
 #¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨#
diff --git a/test/test_files/vortex_dipole_wall_collision/vortex_dipole_wall_collision.inp b/test/test_files/vortex_dipole_wall_collision/vortex_dipole_wall_collision.inp
@@ -18,9 +18,9 @@ time.checkpoint_interval =   -1  # Steps between checkpoint files
 
 incflo.post_processing = enstrophy ke
 ke.type = KineticEnergy
-ke.output_frequency = 1
+ke.output_interval = 1
 enstrophy.type = Enstrophy
-enstrophy.output_frequency = 1
+enstrophy.output_interval = 1
 
 io.derived_outputs = q_criterion mag_vorticity
 #¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨#
diff --git a/unit_tests/utilities/test_field_norms.cpp b/unit_tests/utilities/test_field_norms.cpp
@@ -149,7 +149,7 @@ class FieldNormsTest : public MeshTest
     static void setup_fnorm(bool levelmask_flag)
     {
         amrex::ParmParse pp("fieldnorm");
-        pp.add("output_frequency", 1);
+        pp.add("output_interval", 1);
         if (!levelmask_flag) {
             pp.add("mask_redundant_grids", false);
         }
diff --git a/unit_tests/utilities/test_free_surface.cpp b/unit_tests/utilities/test_free_surface.cpp
@@ -373,7 +373,7 @@ class FreeSurfaceTest : public MeshTest
     void setup_grid_0d(int ninst, const std::string& fsname)
     {
         amrex::ParmParse pp(fsname);
-        pp.add("output_frequency", 1);
+        pp.add("output_interval", 1);
         pp.add("num_instances", ninst);
         pp.addarr("plane_num_points", amrex::Vector<int>{1, 1});
         pp.addarr("plane_start", m_pt_coord);
@@ -383,7 +383,7 @@ class FreeSurfaceTest : public MeshTest
     void setup_grid_2d(int ninst)
     {
         amrex::ParmParse pp("freesurface");
-        pp.add("output_frequency", 1);
+        pp.add("output_interval", 1);
         pp.add("num_instances", ninst);
         pp.addarr("plane_num_points", amrex::Vector<int>{npts, npts});
         pp.addarr("plane_start", m_pl_start);
@@ -392,7 +392,7 @@ class FreeSurfaceTest : public MeshTest
     void setup_grid_2d_narrow(const std::string& fsname)
     {
         amrex::ParmParse pp(fsname);
-        pp.add("output_frequency", 1);
+        pp.add("output_interval", 1);
         pp.add("num_instances", 1);
         pp.addarr("plane_num_points", amrex::Vector<int>{npts, npts});
         pp.addarr("plane_start", m_plnarrow_s);
diff --git a/unit_tests/utilities/test_sampling.cpp b/unit_tests/utilities/test_sampling.cpp
@@ -210,7 +210,7 @@ TEST_F(SamplingTest, sampling)
 
     {
         amrex::ParmParse pp("sampling");
-        pp.add("output_frequency", 1);
+        pp.add("output_interval", 1);
         pp.addarr("labels", amrex::Vector<std::string>{"line1"});
         pp.addarr(
             "fields",
@@ -249,7 +249,7 @@ TEST_F(SamplingTest, sampling_timing)
 
     {
         amrex::ParmParse pp("sampling");
-        pp.add("output_frequency", 1);
+        pp.add("output_interval", 1);
         pp.add("output_delay", 1);
         pp.addarr("labels", amrex::Vector<std::string>{"line1"});
         pp.addarr(
diff --git a/unit_tests/utilities/test_wave_energy.cpp b/unit_tests/utilities/test_wave_energy.cpp
@@ -92,7 +92,7 @@ class WaveEnergyTest : public MeshTest
         }
         {
             amrex::ParmParse pp("waveenergy");
-            pp.add("output_frequency", 1);
+            pp.add("output_interval", 1);
             pp.add("water_level", m_wlev);
         }
         {
