Rename AuxKernels Ref idaholab#29513

loganharbour · Nov 13, 2024 · 40c61a6 · 40c61a6
1 parent 5786159
commit 40c61a6
Show file tree

Hide file tree

Showing 88 changed files with 152 additions and 153 deletions.
diff --git a/modules/subchannel/doc/content/source/auxkernels/BlockedMassFlowRateAux.md b/modules/subchannel/doc/content/source/auxkernels/BlockedMassFlowRateAux.md
diff --git a/modules/subchannel/doc/content/source/auxkernels/SCMBlockedMassFlowRateAux.md b/modules/subchannel/doc/content/source/auxkernels/SCMBlockedMassFlowRateAux.md
@@ -0,0 +1,26 @@
+# SCMBlockedMassFlowRateAux
+
+!syntax description /AuxKernels/SCMBlockedMassFlowRateAux
+
+## Overview
+
+<!-- -->
+
+In the case were there is a partial blockage in the inlet of the subchannel sub-assembly, the user can use the `SCMBlockedMassFlowRateAux` kernel to define an appropiate mass-flow distribution at the inlet.
+The user must define the [!param](/AuxKernels/SCMBlockedMassFlowRateAux/variable) (must be `mdot`), a low mass-flux and a normal mass-flux, as well as the indexes of the blocked subchannels. The low mass-flux [!param](/AuxKernels/SCMBlockedMassFlowRateAux/blocked_mass_flux) will be
+applied to the blocked subchannels who have the indexes [!param](/AuxKernels/SCMBlockedMassFlowRateAux/index_blockage). Ideally, the low mass-flux would be zero, but since that would lead to numerical instabilities
+a low value is suggested instead. It is up to the user to decide what that value would be. The normal mass-flux [!param](/AuxKernels/SCMBlockedMassFlowRateAux/unblocked_mass_flux) will be applied to the unblocked subchannels.
+The flow rate for each subchannel is defined as the product of the mass-flux $\times$ the surface area of each subchannel.
+The user may opt to apply that condition at the inlet [!param](/AuxKernels/SCMBlockedMassFlowRateAux/boundary) or the whole domain.
+
+## Example Input File Syntax
+
+!listing /test/tests/auxkernels/mass_flow_rate/blocked_test.i block=AuxKernels language=cpp
+
+!listing /examples/Blockage/FFM-2B.i block=AuxKernels language=cpp
+
+!syntax parameters /AuxKernels/SCMBlockedMassFlowRateAux
+
+!syntax inputs /AuxKernels/SCMBlockedMassFlowRateAux
+
+!syntax children /AuxKernels/SCMBlockedMassFlowRateAux
diff --git a/modules/subchannel/doc/content/source/auxkernels/SCMFlatMassFlowRateAux.md b/modules/subchannel/doc/content/source/auxkernels/SCMFlatMassFlowRateAux.md
@@ -0,0 +1,20 @@
+# SCMFlatMassFlowRateAux
+
+!syntax description /AuxKernels/SCMFlatMassFlowRateAux
+
+## Overview
+
+<!-- -->
+
+In the case were the user wants to define a uniform mass flow rate at the inlet, the `SCMFlatMassFlowRateAux`
+kernel can be used. In this kernel the user must define a total [!param](/AuxKernels/SCMFlatMassFlowRateAux/mass_flow) rate  which will be divided equally among the subchannels.
+
+## Example Input File Syntax
+
+!listing /test/tests/auxkernels/uniform_mass_flow_rate/test.i block=AuxKernels language=cpp
+
+!syntax parameters /AuxKernels/SCMFlatMassFlowRateAux
+
+!syntax inputs /AuxKernels/SCMFlatMassFlowRateAux
+
+!syntax children /AuxKernels/SCMFlatMassFlowRateAux
diff --git a/...tent/source/auxkernels/MassFlowRateAux.md → ...t/source/auxkernels/SCMMassFlowRateAux.md b/...tent/source/auxkernels/MassFlowRateAux.md → ...t/source/auxkernels/SCMMassFlowRateAux.md
@@ -1,22 +1,22 @@
-# MassFlowRateAux
+# SCMMassFlowRateAux
 
-!syntax description /AuxKernels/MassFlowRateAux
+!syntax description /AuxKernels/SCMMassFlowRateAux
 
 ## Overview
 
 <!-- -->
 
-This is the usual kernel that the user can use to define the mass-flow rate distribution at the inlet [!param](/AuxKernels/MassFlowRateAux/boundary).
-In addition to the boundary, the user must define the [!param](/AuxKernels/MassFlowRateAux/variable) (must be `mdot`) and a uniform [!param](/AuxKernels/MassFlowRateAux/mass_flux),
+This is the usual kernel that the user can use to define the mass-flow rate distribution at the inlet [!param](/AuxKernels/SCMMassFlowRateAux/boundary).
+In addition to the boundary, the user must define the [!param](/AuxKernels/SCMMassFlowRateAux/variable) (must be `mdot`) and a uniform [!param](/AuxKernels/SCMMassFlowRateAux/mass_flux),
 which suggest a more or less uniform velocity profile at the boundary. This mass-flux can be either a `Real` or a [Postprocessor](/Postprocessors/index.md).
 The mass-flow rate for each subchannel is calculated as the product of the mass-flux $\times$ the surface area of each subchannel at the boundary.
 
 ## Example Input File Syntax
 
 !listing /examples/psbt/psbt_ss/psbt.i block=AuxKernels language=cpp
 
-!syntax parameters /AuxKernels/MassFlowRateAux
+!syntax parameters /AuxKernels/SCMMassFlowRateAux
 
-!syntax inputs /AuxKernels/MassFlowRateAux
+!syntax inputs /AuxKernels/SCMMassFlowRateAux
 
-!syntax children /AuxKernels/MassFlowRateAux
+!syntax children /AuxKernels/SCMMassFlowRateAux
diff --git a/...subchannel/doc/content/source/auxkernels/UniformlyDistributedMassFlowRateAux.md b/...subchannel/doc/content/source/auxkernels/UniformlyDistributedMassFlowRateAux.md
diff --git a/modules/subchannel/examples/ABR/fuel_assembly.i b/modules/subchannel/examples/ABR/fuel_assembly.i
@@ -229,7 +229,7 @@ duct_inside = '${fparse duct_outside - 2 * duct_thickness}'
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/ABTR/ABTR_core/fuel_assembly.i b/modules/subchannel/examples/ABTR/ABTR_core/fuel_assembly.i
@@ -250,7 +250,7 @@ duct_inside = '${fparse duct_outside - 2 * duct_thickness}'
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/ABTR/ABTR_core_low_flow/fuel_assembly.i b/modules/subchannel/examples/ABTR/ABTR_core_low_flow/fuel_assembly.i
@@ -245,7 +245,7 @@ duct_inside = '${fparse duct_outside - 2 * duct_thickness}'
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/ABTR/ABTR_core_transient/fuel_assembly.i b/modules/subchannel/examples/ABTR/ABTR_core_transient/fuel_assembly.i
@@ -249,7 +249,7 @@ duct_inside = '${fparse duct_outside - 2 * duct_thickness}'
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/Blockage/7X7blockage70.i b/modules/subchannel/examples/Blockage/7X7blockage70.i
@@ -157,7 +157,7 @@ P_out = 101325 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/Blockage/7X7blockage90.i b/modules/subchannel/examples/Blockage/7X7blockage90.i
@@ -157,7 +157,7 @@ P_out = 101325 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/Blockage/FFM-2B.i b/modules/subchannel/examples/Blockage/FFM-2B.i
@@ -1,6 +1,6 @@
 # M. H. Fontana et al 1973, 1976, Inlet blockage, Case 719.
 # This input file models a block at the inlet of the assembly,
-# using the aux kernel BlockedMassFlowRateAux. The affected subchannels get a mass flux BC that is
+# using the aux kernel SCMBlockedMassFlowRateAux. The affected subchannels get a mass flux BC that is
 # user defined to be very low.
 T_in = 589.15
 A12 = 1.00423e3
@@ -155,7 +155,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = BlockedMassFlowRateAux
+    type = SCMBlockedMassFlowRateAux
     variable = mdot
     boundary = inlet
     index_blockage = '0 1 2 3 4 5 11 22 21 10 20 19 9'

diff --git a/modules/subchannel/examples/Blockage/FFM-3A.i b/modules/subchannel/examples/Blockage/FFM-3A.i
@@ -156,7 +156,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/Blockage/FFM-5B.i b/modules/subchannel/examples/Blockage/FFM-5B.i
@@ -157,7 +157,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/EBR-II/XX09_SC_SS.i b/modules/subchannel/examples/EBR-II/XX09_SC_SS.i
@@ -241,7 +241,7 @@ unheated_length_exit = '${fparse 26.9*scale_factor}'
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/EBR-II/XX09_SC_SS45.i b/modules/subchannel/examples/EBR-II/XX09_SC_SS45.i
@@ -224,7 +224,7 @@ unheated_length_exit = '${fparse 26.9*scale_factor}'
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/EBR-II/XX09_SC_tr.i b/modules/subchannel/examples/EBR-II/XX09_SC_tr.i
@@ -236,7 +236,7 @@ unheated_length_exit = '${fparse 26.9*scale_factor}'
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/MultiAppTests/fuel_assembly.i b/modules/subchannel/examples/MultiAppTests/fuel_assembly.i
@@ -251,7 +251,7 @@ duct_inside = '${fparse duct_outside - 2 * duct_thickness}'
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/ORNL_19/ORNL_19.i b/modules/subchannel/examples/ORNL_19/ORNL_19.i
@@ -153,7 +153,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/ORNL_19/test.i b/modules/subchannel/examples/ORNL_19/test.i
@@ -146,7 +146,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/ORNL_19/test_ORNL_19.i b/modules/subchannel/examples/ORNL_19/test_ORNL_19.i
@@ -154,7 +154,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/ORNL_19/test_Westin.i b/modules/subchannel/examples/ORNL_19/test_Westin.i
@@ -147,7 +147,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/TAMU/TAMU_61.i b/modules/subchannel/examples/TAMU/TAMU_61.i
@@ -151,7 +151,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/Toshiba_37_pin/toshiba_37_pin.i b/modules/subchannel/examples/Toshiba_37_pin/toshiba_37_pin.i
@@ -143,7 +143,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/areva_FCTF/FCTF_deformed.i b/modules/subchannel/examples/areva_FCTF/FCTF_deformed.i
@@ -232,7 +232,7 @@ unheated_length_exit = 0.855 #m
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/areva_FCTF/FCTF_non_deformed.i b/modules/subchannel/examples/areva_FCTF/FCTF_non_deformed.i
@@ -227,7 +227,7 @@ unheated_length_exit = 0.855 #m
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/buoyancy/steady_state/2X6_ss.i b/modules/subchannel/examples/buoyancy/steady_state/2X6_ss.i
@@ -173,7 +173,7 @@ P_out = 101325 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/buoyancy/transient/2X6_transient.i b/modules/subchannel/examples/buoyancy/transient/2X6_transient.i
@@ -131,7 +131,7 @@ P_out = 101325 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/coupling/1pinHex_thermomech_SCM/seven_pin_problem.i b/modules/subchannel/examples/coupling/1pinHex_thermomech_SCM/seven_pin_problem.i
@@ -193,7 +193,7 @@ pitch = 7.26e-3
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/coupling/1pinSquare_thermomech_SCM/one_pin_problem.i b/modules/subchannel/examples/coupling/1pinSquare_thermomech_SCM/one_pin_problem.i
@@ -183,7 +183,7 @@ heated_length = 1.0
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/coupling/BISON_SCM/main.i b/modules/subchannel/examples/coupling/BISON_SCM/main.i
@@ -184,7 +184,7 @@ pitch = 0.0126
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/coupling/HeatConduction_SCM/main.i b/modules/subchannel/examples/coupling/HeatConduction_SCM/main.i
@@ -181,7 +181,7 @@ heated_length = 1.0 # m
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/coupling/THM_SCM/subchannel.i b/modules/subchannel/examples/coupling/THM_SCM/subchannel.i
@@ -194,7 +194,7 @@ heated_length = 1.0
     block = subchannel
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S

diff --git a/modules/subchannel/examples/duct/test.i b/modules/subchannel/examples/duct/test.i
@@ -179,7 +179,7 @@ P_out = 2.0e5 # Pa
     execute_on = 'timestep_begin'
   []
   [mdot_in_bc]
-    type = MassFlowRateAux
+    type = SCMMassFlowRateAux
     variable = mdot
     boundary = inlet
     area = S