Skip to content

Commit

Permalink
Improve documentation on ICs idaholab#29484
Browse files Browse the repository at this point in the history
  • Loading branch information
@kyriv1980
kyriv1980 committed Oct 24, 2024
1 parent 8671db6 commit 418a425
Show file tree
Hide file tree
Showing 19 changed files with 120 additions and 252 deletions.
20 changes: 6 additions & 14 deletions modules/subchannel/doc/content/source/ics/FCTFdisplacementIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
20 changes: 6 additions & 14 deletions modules/subchannel/doc/content/source/ics/MassFlowRateIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
21 changes: 7 additions & 14 deletions modules/subchannel/doc/content/source/ics/QuadFlowAreaIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
21 changes: 7 additions & 14 deletions modules/subchannel/doc/content/source/ics/QuadInterWrapperFlowAreaIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
22 changes: 4 additions & 18 deletions modules/subchannel/doc/content/source/ics/QuadInterWrapperPowerIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
22 changes: 4 additions & 18 deletions modules/subchannel/doc/content/source/ics/QuadInterWrapperWettedPerimIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
38 changes: 25 additions & 13 deletions modules/subchannel/doc/content/source/ics/QuadPowerIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
22 changes: 4 additions & 18 deletions modules/subchannel/doc/content/source/ics/QuadWettedPerimIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
22 changes: 4 additions & 18 deletions modules/subchannel/doc/content/source/ics/TriFlowAreaIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
22 changes: 4 additions & 18 deletions modules/subchannel/doc/content/source/ics/TriInterWrapperFlowAreaIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
22 changes: 4 additions & 18 deletions modules/subchannel/doc/content/source/ics/TriInterWrapperPowerIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
22 changes: 4 additions & 18 deletions modules/subchannel/doc/content/source/ics/TriInterWrapperWettedPerimIC.md
View file
Original file line number Diff line number Diff line change
@@ -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
Loading

0 comments on commit 418a425

Please sign in to comment.