Improve documentation on outputs idaholab#29484

modules/subchannel/doc/content/source/outputs/QuadSubChannelNormalSliceValues.md

@@ -1,20 +1,19 @@
 # QuadSubChannelNormalSliceValues
 
-!alert construction title=Undocumented Class
-The QuadSubChannelNormalSliceValues has not been documented. The content listed below should be used as a starting point for
-documenting the class, which includes the typical automatic documentation associated with a
-MooseObject; however, what is contained is ultimately determined by what is necessary to make the
-documentation clear for users.
-
 !syntax description /Outputs/QuadSubChannelNormalSliceValues
 
 ## Overview
 
-!! Replace these lines with information regarding the QuadSubChannelNormalSliceValues object.
+<!-- -->
+
+This kernel is used to save the solution variables in a file, for the square subchannel problem.
+Imagine a plane perpendicular to the flow direction at a specific height defined by the user.
+The solution variables defined by the user are interpolated at the intersection of that plane
+and the subchannel mesh and printed on that file as a matrix.
 
 ## Example Input File Syntax
 
-!! Describe and include an example of how to use the QuadSubChannelNormalSliceValues object.
+!listing /examples/psbt/psbt_axial/psbt_axial.i block=Outputs language=cpp
 
 !syntax parameters /Outputs/QuadSubChannelNormalSliceValues
 

modules/subchannel/examples/psbt/psbt_axial/3d.i

@@ -3,11 +3,11 @@
     type = DetailedQuadSubChannelMeshGenerator
     nx = 6
     ny = 6
-    n_cells = 50
+    n_cells = 10
     pitch = 0.0126
     rod_diameter = 0.00950
     gap = 0.00095
-    heated_length = 3.658
+    heated_length = 1.0
   []
 []
 

modules/subchannel/examples/psbt/psbt_axial/power_profile.txt

@@ -0,0 +1,25 @@
+1.0
+1.0
+0.25
+0.25
+0.25
+1.0
+1.0
+1.0
+0.25
+0.25
+1.0
+1.0
+0.25
+0.25
+0.25
+1.0
+1.0
+1.0
+0.25
+0.25
+1.0
+1.0
+0.25
+0.25
+0.25

modules/subchannel/examples/psbt/psbt_axial/psbt_axial.i

@@ -1,3 +1,6 @@
+# This is an input file based on M. Avramova et. all 2012,
+# OECD/NRC Benchmark Based on NUPEC PWR
+# Sub-channel and Bundle Tests (PSBT). Volume III: Departure from Nucleate Boiling
 T_in = 359.15
 # [1e+6 kg/m^2-hour] turns into kg/m^2-sec
 mass_flux_in = '${fparse 1e+6 * 17.0 / 3600.}'
@@ -8,7 +11,7 @@ P_out = 4.923e6 # Pa
     type = QuadSubChannelMeshGenerator
     nx = 6
     ny = 6
-    n_cells = 50
+    n_cells = 10
     pitch = 0.0126
     rod_diameter = 0.00950
     gap = 0.00095
@@ -23,7 +26,7 @@ P_out = 4.923e6 # Pa
     type = ParsedFunction
     value = '(pi/2)*sin(pi*z/L)'
     vars = 'L'
-    vals = '${length}'
+    vals = 1.0
   []
 []
 
@@ -39,8 +42,8 @@ P_out = 4.923e6 # Pa
   n_blocks = 1
   beta = 0.006
   CT = 2.0
-  P_tol = 1e-6
-  T_tol = 1e-6
+  P_tol = 1e-4
+  T_tol = 1e-4
   compute_density = true
   compute_viscosity = true
   compute_power = true
@@ -142,14 +145,14 @@ P_out = 4.923e6 # Pa
     variable = T
     execute_on = final
     file_base = "Temp_Out.txt"
-    height = 3.658
+    height = 0.5
   []
   [mdot_Out_MATRIX]
     type = QuadSubChannelNormalSliceValues
     variable = mdot
     execute_on = final
     file_base = "mdot_Out.txt"
-    height = 3.658
+    height = 0.5
   []
   [mdot_In_MATRIX]
     type = QuadSubChannelNormalSliceValues

modules/subchannel/examples/psbt/psbt_null_transient/psbt_ss.i

@@ -1,3 +1,6 @@
+# This is an input file based on M. Avramova et. all 2012,
+# OECD/NRC Benchmark Based on NUPEC PWR
+# Sub-channel and Bundle Tests (PSBT). Volume III: Departure from Nucleate Boiling
 T_in = 359.15
 # [1e+6 kg/m^2-hour] turns into kg/m^2-sec
 mass_flux_in = '${fparse 1e+6 * 17.00 / 3600.}'

modules/subchannel/examples/psbt/psbt_null_transient/psbt_transient.i

@@ -1,3 +1,6 @@
+# This is an input file based on M. Avramova et. all 2012,
+# OECD/NRC Benchmark Based on NUPEC PWR
+# Sub-channel and Bundle Tests (PSBT). Volume III: Departure from Nucleate Boiling
 T_in = 359.15
 # [1e+6 kg/m^2-hour] turns into kg/m^2-sec
 mass_flux_in = '${fparse 1e+6 * 17.00 / 3600.}'

modules/subchannel/examples/psbt/psbt_ss/psbt.i

@@ -1,3 +1,6 @@
+# This is an input file based on M. Avramova et. all 2012,
+# OECD/NRC Benchmark Based on NUPEC PWR
+# Sub-channel and Bundle Tests (PSBT). Volume III: Departure from Nucleate Boiling
 T_in = 359.15
 # [1e+6 kg/m^2-hour] turns into kg/m^2-sec
 mass_flux_in = '${fparse 1e+6 * 17.00 / 3600.}'

modules/subchannel/examples/psbt/psbt_ss/psbt_example.i

@@ -1,4 +1,4 @@
-# M. Avramova et. all 2012,
+# This is an input file based on M. Avramova et. all 2012,
 # OECD/NRC Benchmark Based on NUPEC PWR
 # Sub-channel and Bundle Tests (PSBT). Volume III: Departure from Nucleate Boiling
 T_in = 502.35

modules/subchannel/examples/psbt/psbt_ss/psbt_with_pin.i

@@ -1,3 +1,6 @@
+# This is an input file based on M. Avramova et. all 2012,
+# OECD/NRC Benchmark Based on NUPEC PWR
+# Sub-channel and Bundle Tests (PSBT). Volume III: Departure from Nucleate Boiling
 T_in = 359.15
 # [1e+6 kg/m^2-hour] turns into kg/m^2-sec
 mass_flux_in = '${fparse 1e+6 * 17.00 / 3600.}'

modules/subchannel/examples/psbt/psbt_transient/psbt_transient.i

@@ -1,3 +1,6 @@
+# This is an input file based on M. Avramova et. all 2012,
+# OECD/NRC Benchmark Based on NUPEC PWR
+# Sub-channel and Bundle Tests (PSBT). Volume III: Departure from Nucleate Boiling
 T_in = 359.15
 # [1e+6 kg/m^2-hour] turns into kg/m^2-sec
 mass_flux_in = '${fparse 1e+6 * 17.00 / 3600.}'