Skip to content

Commit 8671db6

Browse files
committed
Improve documentation on AuxKernels idaholab#29484
1 parent d76a801 commit 8671db6

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# RZQPrimeAuxPin
2+
3+
!syntax description /AuxKernels/RZQPrimeAuxPin
4+
5+
## Description
6+
7+
<!-- -->
8+
9+
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.
10+
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
11+
diffusion coefficient and the temperature variable.
12+
13+
## Example Input File Syntax
14+
15+
!listing /examples/coupling/1pinSquare_thermomech_SC/one_pin_problem_sub.i block=AuxKernels language=cpp
16+
17+
!syntax parameters /AuxKernels/RZQPrimeAuxPin
18+
19+
!syntax inputs /AuxKernels/RZQPrimeAuxPin
20+
21+
!syntax children /AuxKernels/RZQPrimeAuxPin

0 commit comments

Comments
 (0)