Improve documentation on AuxKernels idaholab#29484

loganharbour · Oct 24, 2024 · 8671db6 · 8671db6
1 parent d76a801
commit 8671db6
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/modules/subchannel/doc/content/source/auxkernels/RZQPrimeAuxPin.md b/modules/subchannel/doc/content/source/auxkernels/RZQPrimeAuxPin.md
@@ -0,0 +1,21 @@
+# RZQPrimeAuxPin
+
+!syntax description /AuxKernels/RZQPrimeAuxPin
+
+## Description
+
+<!-- -->
+
+The `RZQPrimeAuxPin` AuxKernel is used to compute the linear heat rate (w/m) on the surface of a fuel pin that is modeled with a 2D-RZ axi-symmetric mesh.
+It's a kernel that inherits from `DiffusionFluxAux` to calculate the flux, but in addition it multiplies with the pin diameter. The user needs to provide the
+diffusion coefficient and the temperature variable.
+
+## Example Input File Syntax
+
+!listing /examples/coupling/1pinSquare_thermomech_SC/one_pin_problem_sub.i block=AuxKernels language=cpp
+
+!syntax parameters /AuxKernels/RZQPrimeAuxPin
+
+!syntax inputs /AuxKernels/RZQPrimeAuxPin
+
+!syntax children /AuxKernels/RZQPrimeAuxPin