diff --git a/modules/subchannel/doc/content/source/postprocessors/PinSurfaceTemperature.md b/modules/subchannel/doc/content/source/postprocessors/PinSurfaceTemperature.md index 55d794c7cf64..e54a99b1d84a 100644 --- a/modules/subchannel/doc/content/source/postprocessors/PinSurfaceTemperature.md +++ b/modules/subchannel/doc/content/source/postprocessors/PinSurfaceTemperature.md @@ -1,23 +1,26 @@ # 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 +!syntax description /Postprocessors/PinSurfaceTemperature ## Overview -!! Replace these lines with information regarding the PinSurfaceTemperature object. + + +This is a postprocessor that calculates and prints the pin surface temperature `Tpin`. +To be more exact, `Tpin` is calcualted inside the `SCM` solver: + +The assumption is that each neighboring subchannel to a specific pin sees the same heat flux. +Using a `Dittus-Boelter` approach we calculate surface temperatures for each neighbor. The numerical +average is `Tpin`. + +Then, the postprocessor interpolates the value of the variable `Tpin` at a certain pin and height. ## Example Input File Syntax -!! Describe and include an example of how to use the PinSurfaceTemperature object. +!listing /test/tests/problems/SFR/sodium-19pin/test19_monolithic.i block=Postprocessors language=cpp -!syntax parameters /UserObjects/PinSurfaceTemperature +!syntax parameters /Postprocessors/PinSurfaceTemperature -!syntax inputs /UserObjects/PinSurfaceTemperature +!syntax inputs /Postprocessors/PinSurfaceTemperature -!syntax children /UserObjects/PinSurfaceTemperature +!syntax children /Postprocessors/PinSurfaceTemperature diff --git a/modules/subchannel/doc/content/source/postprocessors/PlanarMean.md b/modules/subchannel/doc/content/source/postprocessors/PlanarMean.md index a07cb13a3568..d1131592a318 100644 --- a/modules/subchannel/doc/content/source/postprocessors/PlanarMean.md +++ b/modules/subchannel/doc/content/source/postprocessors/PlanarMean.md @@ -1,23 +1,15 @@ # 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. +!syntax description /Postprocessors/PlanarMean ## Example Input File Syntax !! Describe and include an example of how to use the PlanarMean object. -!syntax parameters /UserObjects/PlanarMean +!listing /test/tests/problems/psbt/psbt.i block=Postprocessors language=cpp + +!syntax parameters /Postprocessors/PlanarMean -!syntax inputs /UserObjects/PlanarMean +!syntax inputs /Postprocessors/PlanarMean -!syntax children /UserObjects/PlanarMean +!syntax children /Postprocessors/PlanarMean diff --git a/modules/subchannel/doc/content/source/postprocessors/SubChannelDelta.md b/modules/subchannel/doc/content/source/postprocessors/SubChannelDelta.md index fac1192619ee..d71879e3151b 100644 --- a/modules/subchannel/doc/content/source/postprocessors/SubChannelDelta.md +++ b/modules/subchannel/doc/content/source/postprocessors/SubChannelDelta.md @@ -1,23 +1,20 @@ # SubChannelDelta -!alert construction title=Undocumented Class -The SubChannelDelta 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/SubChannelDelta +!syntax description /Postprocessors/SubChannelDelta ## Overview -!! Replace these lines with information regarding the SubChannelDelta object. + + +The user defines the variable which change they want to see along the whole assembly. The postprocessor calculates a +massflow rate weighted average at the inlet and outlet and then prints the absolute difference. ## Example Input File Syntax -!! Describe and include an example of how to use the SubChannelDelta object. +!listing /examples/coupling/THM/subchannel.i block=Postprocessors language=cpp -!syntax parameters /UserObjects/SubChannelDelta +!syntax parameters /Postprocessors/SubChannelDelta -!syntax inputs /UserObjects/SubChannelDelta +!syntax inputs /Postprocessors/SubChannelDelta -!syntax children /UserObjects/SubChannelDelta +!syntax children /Postprocessors/SubChannelDelta diff --git a/modules/subchannel/doc/content/source/postprocessors/SubChannelPointValue.md b/modules/subchannel/doc/content/source/postprocessors/SubChannelPointValue.md index 839f6a25b7c4..6e3a0f7cb820 100644 --- a/modules/subchannel/doc/content/source/postprocessors/SubChannelPointValue.md +++ b/modules/subchannel/doc/content/source/postprocessors/SubChannelPointValue.md @@ -1,23 +1,18 @@ # SubChannelPointValue -!alert construction title=Undocumented Class -The SubChannelPointValue 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/SubChannelPointValue +!syntax description /Postprocessors/SubChannelPointValue ## Overview -!! Replace these lines with information regarding the SubChannelPointValue object. +The user needs to specify the variable whose value they want to see, the index of the subchannel and the height. +The postprocessor will interpolate the value of that variable at that location. ## Example Input File Syntax -!! Describe and include an example of how to use the SubChannelPointValue object. +!listing /test/tests/problems/SFR/THORS/FFM-5B.i block=Postprocessors language=cpp -!syntax parameters /UserObjects/SubChannelPointValue +!syntax parameters /Postprocessors/SubChannelPointValue -!syntax inputs /UserObjects/SubChannelPointValue +!syntax inputs /Postprocessors/SubChannelPointValue -!syntax children /UserObjects/SubChannelPointValue +!syntax children /Postprocessors/SubChannelPointValue diff --git a/modules/subchannel/src/postprocessors/PlanarMean.C b/modules/subchannel/src/postprocessors/PlanarMean.C index 7547668419c0..0a8faaa7da50 100644 --- a/modules/subchannel/src/postprocessors/PlanarMean.C +++ b/modules/subchannel/src/postprocessors/PlanarMean.C @@ -27,7 +27,7 @@ InputParameters PlanarMean::validParams() { InputParameters params = GeneralPostprocessor::validParams(); - params.addClassDescription("Calculates an overall mass-flow-averaged mean of the chosen " + params.addClassDescription("Calculates an overall mass-flow-rate averaged mean of the chosen " "variable on a z-plane at a user defined height"); params.addRequiredParam("variable", "Variable you want the mean of"); params.addRequiredParam("height", "Axial location of plane [m]"); diff --git a/modules/subchannel/src/postprocessors/SubChannelDelta.C b/modules/subchannel/src/postprocessors/SubChannelDelta.C index be945da3d991..d0adc0fabe99 100644 --- a/modules/subchannel/src/postprocessors/SubChannelDelta.C +++ b/modules/subchannel/src/postprocessors/SubChannelDelta.C @@ -27,8 +27,9 @@ InputParameters SubChannelDelta::validParams() { InputParameters params = GeneralPostprocessor::validParams(); - params.addClassDescription("Calculates an overall mass-flow-averaged Delta of the chosen " - "variable for the subchannel assembly"); + params.addClassDescription( + "Calculates an absolute overall mass-flow-rate averaged difference, of a chosen " + "variable, for the whole subchannel assembly, from inlet to outlet"); params.addRequiredParam("variable", "Variable you want the delta of"); return params; }