address review

- updated wording, file names based on suggestions - added docstrings - simplified test, changed dt
idaholab · Nov 27, 2024 · 3c176f1 · 3c176f1
1 parent c915948
commit 3c176f1
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 117 deletions.
diff --git a/framework/doc/content/source/postprocessors/NumTimeSteps.md b/framework/doc/content/source/postprocessors/NumTimeSteps.md
@@ -1,11 +1,7 @@
-# TimestepSize
+# NumTimeSteps
 
 !syntax description /Postprocessors/NumTimeSteps
 
-## Description
-
-`NumTimeSteps` reports the timestep size.
-
 ## Example Input Syntax
 
 !listing /Users/achaube/tools/moose/test/tests/postprocessors/num_time_steps/moose.i block=Postprocessors

diff --git a/framework/include/postprocessors/NumTimeSteps.h b/framework/include/postprocessors/NumTimeSteps.h
@@ -11,6 +11,9 @@
 
 #include "GeneralPostprocessor.h"
 
+/**
+ * Reports on the number of time steps already taken in the transient
+ */
 class NumTimeSteps : public GeneralPostprocessor
 {
 public:

diff --git a/test/tests/postprocessors/num_time_steps/gold/moose_out.csv b/test/tests/postprocessors/num_time_steps/gold/moose_out.csv
diff --git a/test/tests/postprocessors/num_time_steps/gold/numtimesteps_out.csv b/test/tests/postprocessors/num_time_steps/gold/numtimesteps_out.csv
@@ -0,0 +1,12 @@
+time,timestep_ctr
+0,0
+0.001,1
+0.002,2
+0.003,3
+0.004,4
+0.005,5
+0.006,6
+0.007,7
+0.008,8
+0.009,9
+0.01,10
diff --git a/test/tests/postprocessors/num_time_steps/moose.i b/test/tests/postprocessors/num_time_steps/moose.i
diff --git a/test/tests/postprocessors/num_time_steps/numtimesteps.i b/test/tests/postprocessors/num_time_steps/numtimesteps.i
@@ -0,0 +1,23 @@
+[Mesh/gmg]
+  type = GeneratedMeshGenerator
+  dim = 1
+[]
+
+[Postprocessors/timestep_ctr]
+  type = NumTimeSteps
+[]
+
+[Problem]
+  solve = False
+[]
+
+[Executioner]
+  type = Transient
+  dt = 0.001
+  num_steps = 10
+[]
+
+[Outputs]
+  csv = true
+  exodus = false
+[]
diff --git a/test/tests/postprocessors/num_time_steps/tests b/test/tests/postprocessors/num_time_steps/tests
@@ -3,7 +3,7 @@
     type = 'CSVDiff'
     input = 'numtimesteps.i'
     csvdiff = 'numtimesteps_out.csv'
-    requirement = 'The postprocessor `NumTimeSteps` shall count the number of time-steps accurately'
-                   'over the course of a transient solve'
+    requirement = 'The postprocessor shall be able to count the number of time-steps that have been taken '
+                   'over the course of the simulation of a transient.'
   []
 []
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,9 @@ @@
     #include "GeneralPostprocessor.h"
+    /**
+     * Reports on the number of time steps already taken in the transient
+     */
     class NumTimeSteps : public GeneralPostprocessor
     {
     public:
@@ Expand Down @@