From 418a4251b6c36cd3b01a2012d95846eea704cdc2 Mon Sep 17 00:00:00 2001 From: Kyriv Date: Tue, 15 Oct 2024 10:31:58 -0600 Subject: [PATCH] Improve documentation on ICs #29484 --- .../content/source/ics/FCTFdisplacementIC.md | 20 +++------- .../doc/content/source/ics/MassFlowRateIC.md | 20 +++------- .../doc/content/source/ics/QuadFlowAreaIC.md | 21 ++++------ .../source/ics/QuadInterWrapperFlowAreaIC.md | 21 ++++------ .../source/ics/QuadInterWrapperPowerIC.md | 22 ++--------- .../ics/QuadInterWrapperWettedPerimIC.md | 22 ++--------- .../doc/content/source/ics/QuadPowerIC.md | 38 ++++++++++++------- .../content/source/ics/QuadWettedPerimIC.md | 22 ++--------- .../doc/content/source/ics/TriFlowAreaIC.md | 22 ++--------- .../source/ics/TriInterWrapperFlowAreaIC.md | 22 ++--------- .../source/ics/TriInterWrapperPowerIC.md | 22 ++--------- .../ics/TriInterWrapperWettedPerimIC.md | 22 ++--------- .../doc/content/source/ics/TriPowerIC.md | 38 ++++++++++++------- .../content/source/ics/TriWettedPerimIC.md | 22 ++--------- .../doc/content/source/ics/ViscosityIC.md | 20 +++------- .../subchannel/src/ics/FCTFdisplacementIC.C | 2 +- modules/subchannel/src/ics/MassFlowRateIC.C | 2 +- modules/subchannel/src/ics/QuadPowerIC.C | 8 ++-- modules/subchannel/src/ics/TriPowerIC.C | 6 +-- 19 files changed, 120 insertions(+), 252 deletions(-) diff --git a/modules/subchannel/doc/content/source/ics/FCTFdisplacementIC.md b/modules/subchannel/doc/content/source/ics/FCTFdisplacementIC.md index 578a995750c3..41d54a321085 100644 --- a/modules/subchannel/doc/content/source/ics/FCTFdisplacementIC.md +++ b/modules/subchannel/doc/content/source/ics/FCTFdisplacementIC.md @@ -1,23 +1,15 @@ # 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 +!syntax description /ICs/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. +This is a custom, hard coded kernel, that calculates the deformation of the duct (`displacement` [AuxVariable](https://mooseframework.inl.gov/syntax/AuxVariables/index.html)) for the [AREVA FCTF](https://www.osti.gov/servlets/purl/1346027/). -!syntax parameters /Variables/InitialCondition/FCTFdisplacementIC +!syntax parameters /ICs/FCTFdisplacementIC -!syntax inputs /Variables/InitialCondition/FCTFdisplacementIC +!syntax inputs /ICs/FCTFdisplacementIC -!syntax children /Variables/InitialCondition/FCTFdisplacementIC +!syntax children /ICs/FCTFdisplacementIC diff --git a/modules/subchannel/doc/content/source/ics/MassFlowRateIC.md b/modules/subchannel/doc/content/source/ics/MassFlowRateIC.md index 1341d5fcd6ca..31a20a272d32 100644 --- a/modules/subchannel/doc/content/source/ics/MassFlowRateIC.md +++ b/modules/subchannel/doc/content/source/ics/MassFlowRateIC.md @@ -1,23 +1,15 @@ # MassFlowRateIC -!alert construction title=Undocumented Class -The MassFlowRateIC 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/MassFlowRateIC +!syntax description /ICs/MassFlowRateIC ## Overview -!! Replace these lines with information regarding the MassFlowRateIC object. - -## Example Input File Syntax + -!! Describe and include an example of how to use the MassFlowRateIC object. +This kernel creates an initial field for mass flow rate by mutiplying a user provided mass flux with the subchannel flow area. -!syntax parameters /Variables/InitialCondition/MassFlowRateIC +!syntax parameters /ICs/MassFlowRateIC -!syntax inputs /Variables/InitialCondition/MassFlowRateIC +!syntax inputs /ICs/MassFlowRateIC -!syntax children /Variables/InitialCondition/MassFlowRateIC +!syntax children /ICs/MassFlowRateIC diff --git a/modules/subchannel/doc/content/source/ics/QuadFlowAreaIC.md b/modules/subchannel/doc/content/source/ics/QuadFlowAreaIC.md index a6f6056518fb..7a31cc04e327 100644 --- a/modules/subchannel/doc/content/source/ics/QuadFlowAreaIC.md +++ b/modules/subchannel/doc/content/source/ics/QuadFlowAreaIC.md @@ -1,23 +1,16 @@ # QuadFlowAreaIC -!alert construction title=Undocumented Class -The QuadFlowAreaIC 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/QuadFlowAreaIC +!syntax description /ICs/QuadFlowAreaIC ## Overview -!! Replace these lines with information regarding the QuadFlowAreaIC object. - -## Example Input File Syntax + -!! Describe and include an example of how to use the QuadFlowAreaIC object. +This kernel populates the auxiliary variable S (subchannel surface area) at the beginning of the problem +for a sub-assembly with a square subchannel/pin arrangement. -!syntax parameters /Variables/InitialCondition/QuadFlowAreaIC +!syntax parameters /ICs/QuadFlowAreaIC -!syntax inputs /Variables/InitialCondition/QuadFlowAreaIC +!syntax inputs /ICs/QuadFlowAreaIC -!syntax children /Variables/InitialCondition/QuadFlowAreaIC +!syntax children /ICs/QuadFlowAreaIC diff --git a/modules/subchannel/doc/content/source/ics/QuadInterWrapperFlowAreaIC.md b/modules/subchannel/doc/content/source/ics/QuadInterWrapperFlowAreaIC.md index c2bdeea18b65..051bc87f1896 100644 --- a/modules/subchannel/doc/content/source/ics/QuadInterWrapperFlowAreaIC.md +++ b/modules/subchannel/doc/content/source/ics/QuadInterWrapperFlowAreaIC.md @@ -1,23 +1,16 @@ # QuadInterWrapperFlowAreaIC -!alert construction title=Undocumented Class -The QuadInterWrapperFlowAreaIC 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/QuadInterWrapperFlowAreaIC +!syntax description /ICs/QuadInterWrapperFlowAreaIC ## Overview -!! Replace these lines with information regarding the QuadInterWrapperFlowAreaIC object. - -## Example Input File Syntax + -!! Describe and include an example of how to use the QuadInterWrapperFlowAreaIC object. +This kernel populates the auxiliary variable S (inter-wrapper cell surface area) at the beginning of the for the inter-wrapper problem +for a sub-assembly with a square subchannel/pin arrangement. -!syntax parameters /Variables/InitialCondition/QuadInterWrapperFlowAreaIC +!syntax parameters /ICs/QuadInterWrapperFlowAreaIC -!syntax inputs /Variables/InitialCondition/QuadInterWrapperFlowAreaIC +!syntax inputs /ICs/QuadInterWrapperFlowAreaIC -!syntax children /Variables/InitialCondition/QuadInterWrapperFlowAreaIC +!syntax children /ICs/QuadInterWrapperFlowAreaIC diff --git a/modules/subchannel/doc/content/source/ics/QuadInterWrapperPowerIC.md b/modules/subchannel/doc/content/source/ics/QuadInterWrapperPowerIC.md index 38ff097524ef..8298ed48b1cc 100644 --- a/modules/subchannel/doc/content/source/ics/QuadInterWrapperPowerIC.md +++ b/modules/subchannel/doc/content/source/ics/QuadInterWrapperPowerIC.md @@ -1,23 +1,9 @@ # QuadInterWrapperPowerIC -!alert construction title=Undocumented Class -The QuadInterWrapperPowerIC 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 /ICs/QuadInterWrapperPowerIC -!syntax description /Variables/InitialCondition/QuadInterWrapperPowerIC +!syntax parameters /ICs/QuadInterWrapperPowerIC -## Overview +!syntax inputs /ICs/QuadInterWrapperPowerIC -!! Replace these lines with information regarding the QuadInterWrapperPowerIC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the QuadInterWrapperPowerIC object. - -!syntax parameters /Variables/InitialCondition/QuadInterWrapperPowerIC - -!syntax inputs /Variables/InitialCondition/QuadInterWrapperPowerIC - -!syntax children /Variables/InitialCondition/QuadInterWrapperPowerIC +!syntax children /ICs/QuadInterWrapperPowerIC diff --git a/modules/subchannel/doc/content/source/ics/QuadInterWrapperWettedPerimIC.md b/modules/subchannel/doc/content/source/ics/QuadInterWrapperWettedPerimIC.md index bdd85a3844d8..bf35f22181cd 100644 --- a/modules/subchannel/doc/content/source/ics/QuadInterWrapperWettedPerimIC.md +++ b/modules/subchannel/doc/content/source/ics/QuadInterWrapperWettedPerimIC.md @@ -1,23 +1,9 @@ # QuadInterWrapperWettedPerimIC -!alert construction title=Undocumented Class -The QuadInterWrapperWettedPerimIC 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 /ICs/QuadInterWrapperWettedPerimIC -!syntax description /Variables/InitialCondition/QuadInterWrapperWettedPerimIC +!syntax parameters /ICs/QuadInterWrapperWettedPerimIC -## Overview +!syntax inputs /ICs/QuadInterWrapperWettedPerimIC -!! Replace these lines with information regarding the QuadInterWrapperWettedPerimIC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the QuadInterWrapperWettedPerimIC object. - -!syntax parameters /Variables/InitialCondition/QuadInterWrapperWettedPerimIC - -!syntax inputs /Variables/InitialCondition/QuadInterWrapperWettedPerimIC - -!syntax children /Variables/InitialCondition/QuadInterWrapperWettedPerimIC +!syntax children /ICs/QuadInterWrapperWettedPerimIC diff --git a/modules/subchannel/doc/content/source/ics/QuadPowerIC.md b/modules/subchannel/doc/content/source/ics/QuadPowerIC.md index 235fd6949fa7..b3b85cba3cc7 100644 --- a/modules/subchannel/doc/content/source/ics/QuadPowerIC.md +++ b/modules/subchannel/doc/content/source/ics/QuadPowerIC.md @@ -1,23 +1,35 @@ # QuadPowerIC -!alert construction title=Undocumented Class -The QuadPowerIC 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/QuadPowerIC +!syntax description /ICs/QuadPowerIC ## Overview -!! Replace these lines with information regarding the QuadPowerIC object. + + +This kernel assigns the axial heat rate on the subchannels or pins in the case of a problem with subchannels/pins in a +square lattice arrangement. The user must provide the total power of the subassembly, the axial shape of the power profile and the radial +power distribution (power per pin). The axial power profile is given as a function, which integral over the length of the heated portion of the pin, is equal +to the length of the heated portion of the pin. The radial power distribution is given as a column of numbers in a .txt file that has as many entries as the number of pins. + +If the first entry is 1.0, that means that the pin with index 0 is at 100% power. If the 5th entry has a value of 0.0 that means that pin with index 4 has 0% power, etc. +The pin and subchannel indexes are presented in [user notes page](http://127.0.0.1:8000/getting_started/user_notes.html). + +A pin with 100% power has a value of power which is equal to the total power of the subassembly divided with the total number of heated pins (if a pin has zero power it doesn't count in that number). + +The total power of pin with index 6 is calculated as the product of the 100% pin power, times the value on the 7th line of the radial power distribution .txt file. Hence the user +should pay attention that the sum of entries on the radial power distribution file should be equal to the number of heated pins. + +The axial heat rate at a specific height is the product of the total power of the pin, times the value of the axial power profile function, at that height. + +## Caveat -## Example Input File Syntax + -!! Describe and include an example of how to use the QuadPowerIC object. +If the user has created a mesh for the pins, the axial hear rate will be assigned to the nodes of the pin mesh. If the user hasn't created a pin mesh the appropiate heat rate will be assigned to +the nodes of the subchannel mesh. -!syntax parameters /Variables/InitialCondition/QuadPowerIC +!syntax parameters /ICs/QuadPowerIC -!syntax inputs /Variables/InitialCondition/QuadPowerIC +!syntax inputs /ICs/QuadPowerIC -!syntax children /Variables/InitialCondition/QuadPowerIC +!syntax children /ICs/QuadPowerIC diff --git a/modules/subchannel/doc/content/source/ics/QuadWettedPerimIC.md b/modules/subchannel/doc/content/source/ics/QuadWettedPerimIC.md index a556a84e439a..24b4eae4bc4f 100644 --- a/modules/subchannel/doc/content/source/ics/QuadWettedPerimIC.md +++ b/modules/subchannel/doc/content/source/ics/QuadWettedPerimIC.md @@ -1,23 +1,9 @@ # QuadWettedPerimIC -!alert construction title=Undocumented Class -The QuadWettedPerimIC 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 /ICs/QuadWettedPerimIC -!syntax description /Variables/InitialCondition/QuadWettedPerimIC +!syntax parameters /ICs/QuadWettedPerimIC -## Overview +!syntax inputs /ICs/QuadWettedPerimIC -!! Replace these lines with information regarding the QuadWettedPerimIC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the QuadWettedPerimIC object. - -!syntax parameters /Variables/InitialCondition/QuadWettedPerimIC - -!syntax inputs /Variables/InitialCondition/QuadWettedPerimIC - -!syntax children /Variables/InitialCondition/QuadWettedPerimIC +!syntax children /ICs/QuadWettedPerimIC diff --git a/modules/subchannel/doc/content/source/ics/TriFlowAreaIC.md b/modules/subchannel/doc/content/source/ics/TriFlowAreaIC.md index 467a89fe1390..aae1a8187964 100644 --- a/modules/subchannel/doc/content/source/ics/TriFlowAreaIC.md +++ b/modules/subchannel/doc/content/source/ics/TriFlowAreaIC.md @@ -1,23 +1,9 @@ # TriFlowAreaIC -!alert construction title=Undocumented Class -The TriFlowAreaIC 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 /ICs/TriFlowAreaIC -!syntax description /Variables/InitialCondition/TriFlowAreaIC +!syntax parameters /ICs/TriFlowAreaIC -## Overview +!syntax inputs /ICs/TriFlowAreaIC -!! Replace these lines with information regarding the TriFlowAreaIC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the TriFlowAreaIC object. - -!syntax parameters /Variables/InitialCondition/TriFlowAreaIC - -!syntax inputs /Variables/InitialCondition/TriFlowAreaIC - -!syntax children /Variables/InitialCondition/TriFlowAreaIC +!syntax children /ICs/TriFlowAreaIC diff --git a/modules/subchannel/doc/content/source/ics/TriInterWrapperFlowAreaIC.md b/modules/subchannel/doc/content/source/ics/TriInterWrapperFlowAreaIC.md index 28a3c22354ac..0495b5ede573 100644 --- a/modules/subchannel/doc/content/source/ics/TriInterWrapperFlowAreaIC.md +++ b/modules/subchannel/doc/content/source/ics/TriInterWrapperFlowAreaIC.md @@ -1,23 +1,9 @@ # TriInterWrapperFlowAreaIC -!alert construction title=Undocumented Class -The TriInterWrapperFlowAreaIC 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 /ICs/TriInterWrapperFlowAreaIC -!syntax description /Variables/InitialCondition/TriInterWrapperFlowAreaIC +!syntax parameters /ICs/TriInterWrapperFlowAreaIC -## Overview +!syntax inputs /ICs/TriInterWrapperFlowAreaIC -!! Replace these lines with information regarding the TriInterWrapperFlowAreaIC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the TriInterWrapperFlowAreaIC object. - -!syntax parameters /Variables/InitialCondition/TriInterWrapperFlowAreaIC - -!syntax inputs /Variables/InitialCondition/TriInterWrapperFlowAreaIC - -!syntax children /Variables/InitialCondition/TriInterWrapperFlowAreaIC +!syntax children /ICs/TriInterWrapperFlowAreaIC diff --git a/modules/subchannel/doc/content/source/ics/TriInterWrapperPowerIC.md b/modules/subchannel/doc/content/source/ics/TriInterWrapperPowerIC.md index 51678f57326b..5cc7c4de4953 100644 --- a/modules/subchannel/doc/content/source/ics/TriInterWrapperPowerIC.md +++ b/modules/subchannel/doc/content/source/ics/TriInterWrapperPowerIC.md @@ -1,23 +1,9 @@ # TriInterWrapperPowerIC -!alert construction title=Undocumented Class -The TriInterWrapperPowerIC 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 /ICs/TriInterWrapperPowerIC -!syntax description /Variables/InitialCondition/TriInterWrapperPowerIC +!syntax parameters /ICs/TriInterWrapperPowerIC -## Overview +!syntax inputs /ICs/TriInterWrapperPowerIC -!! Replace these lines with information regarding the TriInterWrapperPowerIC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the TriInterWrapperPowerIC object. - -!syntax parameters /Variables/InitialCondition/TriInterWrapperPowerIC - -!syntax inputs /Variables/InitialCondition/TriInterWrapperPowerIC - -!syntax children /Variables/InitialCondition/TriInterWrapperPowerIC +!syntax children /ICs/TriInterWrapperPowerIC diff --git a/modules/subchannel/doc/content/source/ics/TriInterWrapperWettedPerimIC.md b/modules/subchannel/doc/content/source/ics/TriInterWrapperWettedPerimIC.md index c69903ebbc47..9b50ab3dbfbc 100644 --- a/modules/subchannel/doc/content/source/ics/TriInterWrapperWettedPerimIC.md +++ b/modules/subchannel/doc/content/source/ics/TriInterWrapperWettedPerimIC.md @@ -1,23 +1,9 @@ # TriInterWrapperWettedPerimIC -!alert construction title=Undocumented Class -The TriInterWrapperWettedPerimIC 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 /ICs/TriInterWrapperWettedPerimIC -!syntax description /Variables/InitialCondition/TriInterWrapperWettedPerimIC +!syntax parameters /ICs/TriInterWrapperWettedPerimIC -## Overview +!syntax inputs /ICs/TriInterWrapperWettedPerimIC -!! Replace these lines with information regarding the TriInterWrapperWettedPerimIC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the TriInterWrapperWettedPerimIC object. - -!syntax parameters /Variables/InitialCondition/TriInterWrapperWettedPerimIC - -!syntax inputs /Variables/InitialCondition/TriInterWrapperWettedPerimIC - -!syntax children /Variables/InitialCondition/TriInterWrapperWettedPerimIC +!syntax children /ICs/TriInterWrapperWettedPerimIC diff --git a/modules/subchannel/doc/content/source/ics/TriPowerIC.md b/modules/subchannel/doc/content/source/ics/TriPowerIC.md index 83379c1696b4..96bf15d3041a 100644 --- a/modules/subchannel/doc/content/source/ics/TriPowerIC.md +++ b/modules/subchannel/doc/content/source/ics/TriPowerIC.md @@ -1,23 +1,35 @@ # TriPowerIC -!alert construction title=Undocumented Class -The TriPowerIC 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/TriPowerIC +!syntax description /ICs/TriPowerIC ## Overview -!! Replace these lines with information regarding the TriPowerIC object. + + +This kernel assigns the axial heat rate on the subchannels or pins in the case of a problem with subchannels/pins in a +triangular lattice arrangement. The user must provide the total power of the subassembly, the axial shape of the power profile and the radial +power distribution (power per pin). The axial power profile is given as a function, which integral over the length of the heated portion of the pin, is equal +to the length of the heated portion of the pin. The radial power distribution is given as a column of numbers in a .txt file that has as many entries as the number of pins. + +If the first entry is 1.0, that means that the pin with index 0 is at 100% power. If the 5th entry has a value of 0.0 that means that pin with index 4 has 0% power, etc. +The pin and subchannel indexes are presented in [user notes page](http://127.0.0.1:8000/getting_started/user_notes.html). + +A pin with 100% power has a value of power which is equal to the total power of the subassembly divided with the total number of heated pins (if a pin has zero power it doesn't count in that number). + +The total power of pin with index 6 is calculated as the product of the 100% pin power, times the value on the 7th line of the radial power distribution .txt file. Hence the user +should pay attention that the sum of entries on the radial power distribution file should be equal to the number of heated pins. + +The axial heat rate at a specific height is the product of the total power of the pin, times the value of the axial power profile function, at that height. + +## Caveat -## Example Input File Syntax + -!! Describe and include an example of how to use the TriPowerIC object. +If the user has created a mesh for the pins, the axial hear rate will be assigned to the nodes of the pin mesh. If the user hasn't created a pin mesh the appropiate heat rate will be assigned to +the nodes of the subchannel mesh. -!syntax parameters /Variables/InitialCondition/TriPowerIC +!syntax parameters /ICs/TriPowerIC -!syntax inputs /Variables/InitialCondition/TriPowerIC +!syntax inputs /ICs/TriPowerIC -!syntax children /Variables/InitialCondition/TriPowerIC +!syntax children /ICs/TriPowerIC diff --git a/modules/subchannel/doc/content/source/ics/TriWettedPerimIC.md b/modules/subchannel/doc/content/source/ics/TriWettedPerimIC.md index 53394e156b78..dd7f1808f402 100644 --- a/modules/subchannel/doc/content/source/ics/TriWettedPerimIC.md +++ b/modules/subchannel/doc/content/source/ics/TriWettedPerimIC.md @@ -1,23 +1,9 @@ # TriWettedPerimIC -!alert construction title=Undocumented Class -The TriWettedPerimIC 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 /ICs/TriWettedPerimIC -!syntax description /Variables/InitialCondition/TriWettedPerimIC +!syntax parameters /ICs/TriWettedPerimIC -## Overview +!syntax inputs /ICs/TriWettedPerimIC -!! Replace these lines with information regarding the TriWettedPerimIC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the TriWettedPerimIC object. - -!syntax parameters /Variables/InitialCondition/TriWettedPerimIC - -!syntax inputs /Variables/InitialCondition/TriWettedPerimIC - -!syntax children /Variables/InitialCondition/TriWettedPerimIC +!syntax children /ICs/TriWettedPerimIC diff --git a/modules/subchannel/doc/content/source/ics/ViscosityIC.md b/modules/subchannel/doc/content/source/ics/ViscosityIC.md index c48db79faf98..21ae87b1bb5c 100644 --- a/modules/subchannel/doc/content/source/ics/ViscosityIC.md +++ b/modules/subchannel/doc/content/source/ics/ViscosityIC.md @@ -1,23 +1,13 @@ # ViscosityIC -!alert construction title=Undocumented Class -The ViscosityIC 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/ViscosityIC - -## Overview - -!! Replace these lines with information regarding the ViscosityIC object. +!syntax description /ICs/ViscosityIC ## Example Input File Syntax -!! Describe and include an example of how to use the ViscosityIC object. +!listing /examples/Blockage/FFM-5B.i block=Viscosity_ic language=cpp -!syntax parameters /Variables/InitialCondition/ViscosityIC +!syntax parameters /ICs/ViscosityIC -!syntax inputs /Variables/InitialCondition/ViscosityIC +!syntax inputs /ICs/ViscosityIC -!syntax children /Variables/InitialCondition/ViscosityIC +!syntax children /ICs/ViscosityIC diff --git a/modules/subchannel/src/ics/FCTFdisplacementIC.C b/modules/subchannel/src/ics/FCTFdisplacementIC.C index ce62e8d5a4c8..9d51d7faf65a 100644 --- a/modules/subchannel/src/ics/FCTFdisplacementIC.C +++ b/modules/subchannel/src/ics/FCTFdisplacementIC.C @@ -22,7 +22,7 @@ FCTFdisplacementIC::validParams() { InputParameters params = TriSubChannelBaseIC::validParams(); params.addClassDescription( - "This class calculates the displacement of the duct for the areva FCTF facility"); + "This class calculates the displacement of the duct for the areva FCTF"); return params; } diff --git a/modules/subchannel/src/ics/MassFlowRateIC.C b/modules/subchannel/src/ics/MassFlowRateIC.C index 95fdef5526b5..9268b94632e3 100644 --- a/modules/subchannel/src/ics/MassFlowRateIC.C +++ b/modules/subchannel/src/ics/MassFlowRateIC.C @@ -22,7 +22,7 @@ MassFlowRateIC::validParams() InputParameters params = InitialCondition::validParams(); params.addClassDescription( "Computes mass float rate from specified mass flux and cross-sectional area"); - params.addRequiredCoupledVar("area", "Cross sectional area [m^2]"); + params.addRequiredCoupledVar("area", "Subchannel surface area [m^2]"); params.addRequiredParam("mass_flux", "Specified mass flux [kg/s-m^2]"); return params; } diff --git a/modules/subchannel/src/ics/QuadPowerIC.C b/modules/subchannel/src/ics/QuadPowerIC.C index d5069b0b1176..d15c587b1194 100644 --- a/modules/subchannel/src/ics/QuadPowerIC.C +++ b/modules/subchannel/src/ics/QuadPowerIC.C @@ -25,13 +25,11 @@ InputParameters QuadPowerIC::validParams() { InputParameters params = QuadSubChannelBaseIC::validParams(); - params.addClassDescription("Computes axial power rate (W/m) that goes into the subchannel cells " + params.addClassDescription("Computes axial heat rate (W/m) that goes into the subchannel cells " "or is assigned to the fuel pins, in a square lattice arrangement"); - params.addRequiredParam("power", "[W]"); + params.addRequiredParam("power", "The total power of the subassembly [W]"); params.addRequiredParam( - "filename", - "name of power profile .txt file (should be a single column). It's " - "a Radial Power Profile. [UnitLess]"); + "filename", "name of radial power profile .txt file (should be a single column) [UnitLess]."); params.addParam( "axial_heat_rate", "1.0", diff --git a/modules/subchannel/src/ics/TriPowerIC.C b/modules/subchannel/src/ics/TriPowerIC.C index 53e93a028a13..c451b6c698eb 100644 --- a/modules/subchannel/src/ics/TriPowerIC.C +++ b/modules/subchannel/src/ics/TriPowerIC.C @@ -25,11 +25,9 @@ TriPowerIC::validParams() params.addClassDescription( "Computes axial power rate (W/m) that goes into the subchannel cells " "or is assigned to the fuel pins, in a triangular lattice arrangement"); - params.addRequiredParam("power", "[W]"); + params.addRequiredParam("power", "The total power of the subassembly [W]"); params.addRequiredParam( - "filename", - "Name of file with power profile (values are stored in a single " - "column). It's a radial power profile. [Unitless]"); + "filename", "name of radial power profile .txt file (should be a single column) [UnitLess]."); params.addParam("axial_heat_rate", "1.0", "user provided normalized function of axial heat rate [Unitless]. "