From 5f5be760b504173f6f8f2f3850f5228f8c5c067b Mon Sep 17 00:00:00 2001 From: Kyriv Date: Tue, 15 Oct 2024 09:36:28 -0600 Subject: [PATCH] Improve documentation on AuxKernels #29484 --- .../source/auxkernels/RZQPrimeAuxPin.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 modules/subchannel/doc/content/source/auxkernels/RZQPrimeAuxPin.md diff --git a/modules/subchannel/doc/content/source/auxkernels/RZQPrimeAuxPin.md b/modules/subchannel/doc/content/source/auxkernels/RZQPrimeAuxPin.md new file mode 100644 index 000000000000..8adacd7561e7 --- /dev/null +++ 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