Skip to content

Commit

Permalink
Improve documentation on problems idaholab#29484
Browse files Browse the repository at this point in the history
  • Loading branch information
kyriv1980 committed Oct 24, 2024
1 parent c8a2cea commit 3f53a2f
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 132 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## Overview

<!-- -->

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.

Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

11 changes: 4 additions & 7 deletions modules/subchannel/doc/content/source/problems/NoSolveProblem.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
# NoSolveProblem

!alert construction title=Undocumented Class
The NoSolveProblem 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/NoSolveProblem

## Overview

!! Replace these lines with information regarding the NoSolveProblem object.
<!-- -->

This problem class is used in the input file that creates the detailed mesh. Since the aim is to build
a mesh for visualization purposes, there is no need to solve for anything.

## Example Input File Syntax

Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
# 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.
<!-- -->

The inter-wrapper is the flow area around subchannel subassemblies.
This kernel solves for the flow variables in that area, for the case of subassembies that have subchannels in a square lattice.

The inter-wrapper solver is very similar to the subchannel solver. Information regarding the solver can be found in [subchannel_theory.md].

## Example Input File Syntax

!! Describe and include an example of how to use the QuadInterWrapper1PhaseProblem object.
!listing /test/tests/problems/interwrapper/quad_interwrapper_monolithic.i block=SubChannel language=cpp

!syntax parameters /SubChannel/QuadInterWrapper1PhaseProblem

Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
# 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.
<!-- -->

This class solves for the subchannel flow variables in the case of subchannels arranged in a square lattice.
It inherits from the base class : `SubChannel1PhaseProblem`.

## Example Input File Syntax

!! Describe and include an example of how to use the QuadSubChannel1PhaseProblem object.
!listing /test/tests/problems/psbt/psbt_implicit.i block=SubChannel language=cpp

!syntax parameters /SubChannel/QuadSubChannel1PhaseProblem

Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
# 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
##

<!-- -->

The inter-wrapper is the flow area around subchannel subassemblies.
This kernel solves for the flow variables in that area, for the case of subassembies that have subchannels in a triangular lattice.

!! Replace these lines with information regarding the TriInterWrapper1PhaseProblem object.
The inter-wrapper solver is very similar to the subchannel solver. Information regarding the solver can be found in [subchannel_theory.md].

## Example Input File Syntax

!! Describe and include an example of how to use the TriInterWrapper1PhaseProblem object.
!listing /test/tests/problems/interwrapper/tri_interwrapper_monolithic.i block=SubChannel language=cpp

!syntax parameters /SubChannel/TriInterWrapper1PhaseProblem

Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
# 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.
<!-- -->

This class solves for the subchannel flow variables in the case of subchannels arranged in a triangular lattice.
It inherits from the base class : `SubChannel1PhaseProblem`.

## Example Input File Syntax

!! Describe and include an example of how to use the TriSubChannel1PhaseProblem object.
!listing /test/tests/problems/Lead-LBE-19pin/test_LEAD-19pin.i block=Problem language=cpp

!syntax parameters /SubChannel/TriSubChannel1PhaseProblem

Expand Down

0 comments on commit 3f53a2f

Please sign in to comment.