Improve documentation on AuxKernels idaholab#29484

modules/subchannel/doc/content/source/auxkernels/BlockedMassFlowRateAux.md

@@ -1,20 +1,23 @@
 # BlockedMassFlowRateAux
 
-!alert construction title=Undocumented Class
-The BlockedMassFlowRateAux 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 /AuxKernels/BlockedMassFlowRateAux
 
 ## Overview
 
-!! Replace these lines with information regarding the BlockedMassFlowRateAux object.
+<!-- -->
+
+In the case were there is a partial blockage in the inlet of the subchannel sub-assembly,
+the user can use the `BlockedMassFlowRateAux` kernel to define an appropiate mass flow distribution at the inlet.
+The user must define a low mass-flux and a normal mass-flux. The low mass-flux (`blocked_mass_flux`) will be
+applied to the blocked subchannels. Ideally that value would be zero, but since that would lead to numerical issues a low value is suggested instead.
+The normal mass-flux (`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.
 
 ## Example Input File Syntax
 
-!! Describe and include an example of how to use the BlockedMassFlowRateAux object.
+!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/BlockedMassFlowRateAux
 

modules/subchannel/doc/content/source/auxkernels/DiffusionFluxFVAux.md

@@ -0,0 +1,20 @@
+# DiffusionFluxFVAux
+
+!syntax description /AuxKernels/DiffusionFluxFVAux
+
+## Description
+
+<!-- -->
+
+The `DiffusionFluxFVAux` AuxKernel is used to compute the components of the flux vector for FV diffusion problems. The flux is computed as $J=-D\frac{\partial C}{\partial X}$, where $J$ is the diffusion flux vector, $D$ is the diffusivity or diffusion coefficient, $C$ is the concentration variable, and $X$ is the coordinate.
+
+It supports the definition of the diffusivity with and without automatic differentiation (AD).
+
+!alert warning
+The expression of the diffusive flux in this object is generic, as described, and may differ from the diffusive flux in your specific physics implementation. If so, you may not use this object to compute the diffusive flux.
+
+!syntax parameters /AuxKernels/DiffusionFluxFVAux
+
+!syntax inputs /AuxKernels/DiffusionFluxFVAux
+
+!syntax children /AuxKernels/DiffusionFluxFVAux

modules/subchannel/doc/content/source/auxkernels/MassFlowRateAux.md

@@ -1,20 +1,20 @@
 # MassFlowRateAux
 
-!alert construction title=Undocumented Class
-The MassFlowRateAux 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 /AuxKernels/MassFlowRateAux
 
 ## Overview
 
-!! Replace these lines with information regarding the MassFlowRateAux object.
+<!-- -->
+
+This is the usual kernel that the user can use to define the mass flow rate distribution at the inlet boundary.
+In this case the user must define a uniform mass flux (`mass_flux`) which suggest a more or less uniform velocity
+profile at the inlet. 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.
 
 ## Example Input File Syntax
 
-!! Describe and include an example of how to use the MassFlowRateAux object.
+!listing /examples/psbt/psbt_ss/psbt.i block=AuxKernels language=cpp
 
 !syntax parameters /AuxKernels/MassFlowRateAux
 

modules/subchannel/doc/content/source/auxkernels/PostprocessorConstantAux.md

@@ -0,0 +1,15 @@
+# PostprocessorConstantAux
+
+!syntax description /AuxKernels/PostprocessorConstantAux
+
+## Overview
+
+<!-- -->
+
+The `PostprocessorConstantAux` AuxKernel creates a constant field over the domain. It can read a value from a [Postprocessor](/Postprocessors/index.md).
+
+!syntax parameters /AuxKernels/PostprocessorConstantAux
+
+!syntax inputs /AuxKernels/PostprocessorConstantAux
+
+!syntax children /AuxKernels/PostprocessorConstantAux

modules/subchannel/doc/content/source/auxkernels/QPrimeDuctAux.md

@@ -0,0 +1,15 @@
+# QPrimeDuctAux
+
+!syntax description /AuxKernels/QPrimeDuctAux
+
+## Description
+
+<!-- -->
+
+The `QPrimeDuctAux` AuxKernel is used to compute the axial heat rate on a hexagonal duct surface.
+
+!syntax parameters /AuxKernels/QPrimeDuctAux
+
+!syntax inputs /AuxKernels/QPrimeDuctAux
+
+!syntax children /AuxKernels/QPrimeDuctAux

modules/subchannel/doc/content/source/auxkernels/UniformlyDistributedMassFlowRateAux.md

@@ -1,20 +1,17 @@
 # UniformlyDistributedMassFlowRateAux
 
-!alert construction title=Undocumented Class
-The UniformlyDistributedMassFlowRateAux 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 /AuxKernels/UniformlyDistributedMassFlowRateAux
 
 ## Overview
 
-!! Replace these lines with information regarding the UniformlyDistributedMassFlowRateAux object.
+<!-- -->
+
+In the case were the user wants to define a uniform mass flow rate at the inlet, the `UniformlyDistributedMassFlowRateAux`
+kernel can be used. In this kernel the user must define a total mass flow rate (`mass_flow`) which will be divided equally among the subchannels.
 
 ## Example Input File Syntax
 
-!! Describe and include an example of how to use the UniformlyDistributedMassFlowRateAux object.
+!listing /test/tests/auxkernels/uniform_mass_flow_rate/test.i block=AuxKernels language=cpp
 
 !syntax parameters /AuxKernels/UniformlyDistributedMassFlowRateAux
 

modules/subchannel/doc/content/source/ics/FCTFdisplacementIC.md

@@ -0,0 +1,23 @@
+# FCTFdisplacementIC
+
+!alert construction title=Undocumented Class
+The FCTFdisplacementIC 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 /Variables/InitialCondition/FCTFdisplacementIC
+
+## Overview
+
+!! Replace these lines with information regarding the FCTFdisplacementIC object.
+
+## Example Input File Syntax
+
+!! Describe and include an example of how to use the FCTFdisplacementIC object.
+
+!syntax parameters /Variables/InitialCondition/FCTFdisplacementIC
+
+!syntax inputs /Variables/InitialCondition/FCTFdisplacementIC
+
+!syntax children /Variables/InitialCondition/FCTFdisplacementIC

modules/subchannel/doc/content/source/postprocessors/PinSurfaceTemperature.md

@@ -0,0 +1,23 @@
+# PinSurfaceTemperature
+
+!alert construction title=Undocumented Class
+The PinSurfaceTemperature 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 /UserObjects/PinSurfaceTemperature
+
+## Overview
+
+!! Replace these lines with information regarding the PinSurfaceTemperature object.
+
+## Example Input File Syntax
+
+!! Describe and include an example of how to use the PinSurfaceTemperature object.
+
+!syntax parameters /UserObjects/PinSurfaceTemperature
+
+!syntax inputs /UserObjects/PinSurfaceTemperature
+
+!syntax children /UserObjects/PinSurfaceTemperature

modules/subchannel/doc/content/source/postprocessors/PlanarMean.md

@@ -0,0 +1,23 @@
+# PlanarMean
+
+!alert construction title=Undocumented Class
+The PlanarMean 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 /UserObjects/PlanarMean
+
+## Overview
+
+!! Replace these lines with information regarding the PlanarMean object.
+
+## Example Input File Syntax
+
+!! Describe and include an example of how to use the PlanarMean object.
+
+!syntax parameters /UserObjects/PlanarMean
+
+!syntax inputs /UserObjects/PlanarMean
+
+!syntax children /UserObjects/PlanarMean

modules/subchannel/doc/content/source/postprocessors/SubChannelDelta.md

@@ -10,6 +10,8 @@ documentation clear for users.
 
 ## Overview
 
+<!-- -->
+
 !! Replace these lines with information regarding the SubChannelDelta object.
 
 ## Example Input File Syntax

modules/subchannel/doc/content/source/problems/QuadInterWrapper1PhaseProblem.md

@@ -0,0 +1,23 @@
+# QuadInterWrapper1PhaseProblem
+
+!alert construction title=Undocumented Class
+The QuadInterWrapper1PhaseProblem 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 /SubChannel/QuadInterWrapper1PhaseProblem
+
+## Overview
+
+!! Replace these lines with information regarding the QuadInterWrapper1PhaseProblem object.
+
+## Example Input File Syntax
+
+!! Describe and include an example of how to use the QuadInterWrapper1PhaseProblem object.
+
+!syntax parameters /SubChannel/QuadInterWrapper1PhaseProblem
+
+!syntax inputs /SubChannel/QuadInterWrapper1PhaseProblem
+
+!syntax children /SubChannel/QuadInterWrapper1PhaseProblem

modules/subchannel/doc/content/source/problems/QuadSubChannel1PhaseProblem.md

@@ -0,0 +1,23 @@
+# QuadSubChannel1PhaseProblem
+
+!alert construction title=Undocumented Class
+The QuadSubChannel1PhaseProblem 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 /SubChannel/QuadSubChannel1PhaseProblem
+
+## Overview
+
+!! Replace these lines with information regarding the QuadSubChannel1PhaseProblem object.
+
+## Example Input File Syntax
+
+!! Describe and include an example of how to use the QuadSubChannel1PhaseProblem object.
+
+!syntax parameters /SubChannel/QuadSubChannel1PhaseProblem
+
+!syntax inputs /SubChannel/QuadSubChannel1PhaseProblem
+
+!syntax children /SubChannel/QuadSubChannel1PhaseProblem

modules/subchannel/doc/content/source/problems/TriInterWrapper1PhaseProblem.md

@@ -0,0 +1,23 @@
+# TriInterWrapper1PhaseProblem
+
+!alert construction title=Undocumented Class
+The TriInterWrapper1PhaseProblem 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 /SubChannel/TriInterWrapper1PhaseProblem
+
+## Overview
+
+!! Replace these lines with information regarding the TriInterWrapper1PhaseProblem object.
+
+## Example Input File Syntax
+
+!! Describe and include an example of how to use the TriInterWrapper1PhaseProblem object.
+
+!syntax parameters /SubChannel/TriInterWrapper1PhaseProblem
+
+!syntax inputs /SubChannel/TriInterWrapper1PhaseProblem
+
+!syntax children /SubChannel/TriInterWrapper1PhaseProblem

modules/subchannel/doc/content/source/problems/TriSubChannel1PhaseProblem.md

@@ -0,0 +1,23 @@
+# TriSubChannel1PhaseProblem
+
+!alert construction title=Undocumented Class
+The TriSubChannel1PhaseProblem 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 /SubChannel/TriSubChannel1PhaseProblem
+
+## Overview
+
+!! Replace these lines with information regarding the TriSubChannel1PhaseProblem object.
+
+## Example Input File Syntax
+
+!! Describe and include an example of how to use the TriSubChannel1PhaseProblem object.
+
+!syntax parameters /SubChannel/TriSubChannel1PhaseProblem
+
+!syntax inputs /SubChannel/TriSubChannel1PhaseProblem
+
+!syntax children /SubChannel/TriSubChannel1PhaseProblem

modules/subchannel/src/auxkernels/MassFlowRateAux.C

@@ -20,11 +20,12 @@ InputParameters
 MassFlowRateAux::validParams()
 {
   InputParameters params = AuxKernel::validParams();
-  params.addClassDescription("Computes mass flow rate from specified mass flux and cross-sectional "
-                             "area. Reads postprocessor value");
+  params.addClassDescription(
+      "Computes mass flow rate from specified mass flux and subchannel cross-sectional "
+      "area. Reads postprocessor value");
   params.addRequiredCoupledVar("area", "Cross sectional area [m^2]");
-  params.addRequiredParam<PostprocessorName>("mass_flux",
-                                             "The postprocessor to use for the value of mass_flux");
+  params.addRequiredParam<PostprocessorName>(
+      "mass_flux", "The postprocessor or Real to use for the value of mass_flux");
   return params;
 }