Skip to content

Commit

Permalink
Improve documentation on MeshGenerators idaholab#29484
Browse files Browse the repository at this point in the history
  • Loading branch information
kyriv1980 committed Oct 24, 2024
1 parent c5b003b commit 3710d95
Show file tree
Hide file tree
Showing 23 changed files with 141 additions and 167 deletions.
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# DetailedQuadInterWrapperMeshGenerator

!alert construction title=Undocumented Class
The DetailedQuadInterWrapperMeshGenerator 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 /TriSubChannelMesh/DetailedQuadInterWrapperMeshGenerator
!syntax description /Mesh/DetailedQuadInterWrapperMeshGenerator

## Overview

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

This is a kernel used for visualization purposes only. It is part of an input file that creates
a 3D realistic mesh of the inter-wrapper in a square lattice arrangement. This input file has a Problem block
with `type = NoSolveProblem` because it is not used to perform any calculations. It is used to create a detailed 3D mesh that the `SCM` solution
gets projected on.

## Example Input File Syntax

!! Describe and include an example of how to use the DetailedQuadInterWrapperMeshGenerator object.
!listing /examples/mesh_generator/inter_wrapper_3d.i block=Mesh language=cpp

!syntax parameters /TriSubChannelMesh/DetailedQuadInterWrapperMeshGenerator
!syntax parameters /Mesh/DetailedQuadInterWrapperMeshGenerator

!syntax inputs /TriSubChannelMesh/DetailedQuadInterWrapperMeshGenerator
!syntax inputs /Mesh/DetailedQuadInterWrapperMeshGenerator

!syntax children /TriSubChannelMesh/DetailedQuadInterWrapperMeshGenerator
!syntax children /Mesh/DetailedQuadInterWrapperMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# DetailedQuadPinMeshGenerator

!alert construction title=Undocumented Class
The DetailedQuadPinMeshGenerator 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 /TriSubChannelMesh/DetailedQuadPinMeshGenerator
!syntax description /Mesh/DetailedQuadPinMeshGenerator

## Overview

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

This is a kernel used for visualization purposes only. It is part of an input file that creates
a 3D realistic mesh of the pins in a square lattice arrangement. This input file has a Problem block
with `type = NoSolveProblem` because it is not used to perform any calculations. It is used to create a detailed 3D mesh that the `SCM` solution
gets projected on.

## Example Input File Syntax

!! Describe and include an example of how to use the DetailedQuadPinMeshGenerator object.
!listing /examples/coupling/BISON_SC/detailedMesh.i start=GlobalParams end=AuxVariables language=cpp

!syntax parameters /TriSubChannelMesh/DetailedQuadPinMeshGenerator
!syntax parameters /Mesh/DetailedQuadPinMeshGenerator

!syntax inputs /TriSubChannelMesh/DetailedQuadPinMeshGenerator
!syntax inputs /Mesh/DetailedQuadPinMeshGenerator

!syntax children /TriSubChannelMesh/DetailedQuadPinMeshGenerator
!syntax children /Mesh/DetailedQuadPinMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# DetailedQuadSubChannelMeshGenerator

!alert construction title=Undocumented Class
The DetailedQuadSubChannelMeshGenerator 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 /TriSubChannelMesh/DetailedQuadSubChannelMeshGenerator
!syntax description /Mesh/DetailedQuadSubChannelMeshGenerator

## Overview

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

This is a kernel used for visualization purposes only. It is part of an input file that creates
a 3D realistic mesh of the subchannels in a square lattice arrangement. This input file has a Problem block
with `type = NoSolveProblem` because it is not used to perform any calculations. It is used to create a detailed 3D mesh that the `SCM` solution
gets projected on.

## Example Input File Syntax

!! Describe and include an example of how to use the DetailedQuadSubChannelMeshGenerator object.
!listing /examples/coupling/BISON_SC/detailedMesh.i start=GlobalParams end=AuxVariables language=cpp

!syntax parameters /TriSubChannelMesh/DetailedQuadSubChannelMeshGenerator
!syntax parameters /Mesh/DetailedQuadSubChannelMeshGenerator

!syntax inputs /TriSubChannelMesh/DetailedQuadSubChannelMeshGenerator
!syntax inputs /Mesh/DetailedQuadSubChannelMeshGenerator

!syntax children /TriSubChannelMesh/DetailedQuadSubChannelMeshGenerator
!syntax children /Mesh/DetailedQuadSubChannelMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# DetailedTriPinMeshGenerator

!alert construction title=Undocumented Class
The DetailedTriPinMeshGenerator 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 /TriSubChannelMesh/DetailedTriPinMeshGenerator
!syntax description /Mesh/DetailedTriPinMeshGenerator

## Overview

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

This is a kernel used for visualization purposes only. It is part of an input file that creates
a 3D realistic mesh of the pins in a triangular lattice arrangement. This input file has a Problem block
with `type = NoSolveProblem` because it is not used to perform any calculations. It is used to create a detailed 3D mesh that the `SCM` solution
gets projected on.

## Example Input File Syntax

!! Describe and include an example of how to use the DetailedTriPinMeshGenerator object.
!listing /examples/full-sodium-assembly/3d.i block=Mesh language=cpp

!syntax parameters /TriSubChannelMesh/DetailedTriPinMeshGenerator
!syntax parameters /Mesh/DetailedTriPinMeshGenerator

!syntax inputs /TriSubChannelMesh/DetailedTriPinMeshGenerator
!syntax inputs /Mesh/DetailedTriPinMeshGenerator

!syntax children /TriSubChannelMesh/DetailedTriPinMeshGenerator
!syntax children /Mesh/DetailedTriPinMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# DetailedTriSubChannelMeshGenerator

!alert construction title=Undocumented Class
The DetailedTriSubChannelMeshGenerator 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 /TriSubChannelMesh/DetailedTriSubChannelMeshGenerator
!syntax description /Mesh/DetailedTriSubChannelMeshGenerator

## Overview

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

This is a kernel used for visualization purposes only. It is part of an input file that creates
a 3D realistic mesh of the subchannels in a triangular lattice arrangement. This input file has a Problem block
with `type = NoSolveProblem` because it is not used to perform any calculations. It is used to create a detailed 3D mesh that the `SCM` solution
gets projected on.

## Example Input File Syntax

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

!syntax parameters /TriSubChannelMesh/DetailedTriSubChannelMeshGenerator
!syntax parameters /Mesh/DetailedTriSubChannelMeshGenerator

!syntax inputs /TriSubChannelMesh/DetailedTriSubChannelMeshGenerator
!syntax inputs /Mesh/DetailedTriSubChannelMeshGenerator

!syntax children /TriSubChannelMesh/DetailedTriSubChannelMeshGenerator
!syntax children /Mesh/DetailedTriSubChannelMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
# QuadInterWrapperMeshGenerator

!alert construction title=Undocumented Class
The QuadInterWrapperMeshGenerator 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 /TriSubChannelMesh/QuadInterWrapperMeshGenerator
!syntax description /Mesh/QuadInterWrapperMeshGenerator

## Overview

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

This kernel creates the mesh were the `SCM` solution variables associated with the inter-wrapper live.

## Example Input File Syntax

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

!syntax parameters /TriSubChannelMesh/QuadInterWrapperMeshGenerator
!syntax parameters /Mesh/QuadInterWrapperMeshGenerator

!syntax inputs /TriSubChannelMesh/QuadInterWrapperMeshGenerator
!syntax inputs /Mesh/QuadInterWrapperMeshGenerator

!syntax children /TriSubChannelMesh/QuadInterWrapperMeshGenerator
!syntax children /Mesh/QuadInterWrapperMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
# QuadPinMeshGenerator

!alert construction title=Undocumented Class
The QuadPinMeshGenerator 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 /TriSubChannelMesh/QuadPinMeshGenerator
!syntax description /Mesh/QuadPinMeshGenerator

## Overview

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

This kernel creates the mesh were the `SCM` solution variables associated with the pins live.

## Example Input File Syntax

!! Describe and include an example of how to use the QuadPinMeshGenerator object.
!listing /examples/psbt/psbt_ss/psbt_example.i block=QuadSubChannelMesh language=cpp

!syntax parameters /TriSubChannelMesh/QuadPinMeshGenerator
!syntax parameters /Mesh/QuadPinMeshGenerator

!syntax inputs /TriSubChannelMesh/QuadPinMeshGenerator
!syntax inputs /Mesh/QuadPinMeshGenerator

!syntax children /TriSubChannelMesh/QuadPinMeshGenerator
!syntax children /Mesh/QuadPinMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
# QuadSubChannelMeshGenerator

!alert construction title=Undocumented Class
The QuadSubChannelMeshGenerator 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 /TriSubChannelMesh/QuadSubChannelMeshGenerator
!syntax description /Mesh/QuadSubChannelMeshGenerator

## Overview

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

This kernel creates the mesh were the `SCM` solution variables associated with the subchannels live.

## Example Input File Syntax

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

!syntax parameters /TriSubChannelMesh/QuadSubChannelMeshGenerator
!syntax parameters /Mesh/QuadSubChannelMeshGenerator

!syntax inputs /TriSubChannelMesh/QuadSubChannelMeshGenerator
!syntax inputs /Mesh/QuadSubChannelMeshGenerator

!syntax children /TriSubChannelMesh/QuadSubChannelMeshGenerator
!syntax children /Mesh/QuadSubChannelMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
# TriDuctMeshGenerator

!alert construction title=Undocumented Class
The TriDuctMeshGenerator 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 /TriSubChannelMesh/TriDuctMeshGenerator
!syntax description /Mesh/TriDuctMeshGenerator

## Overview

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

This kernel creates the mesh were the variables associated with the duct live.

## Example Input File Syntax

!! Describe and include an example of how to use the TriDuctMeshGenerator object.
!listing /examples/duct/test.i block=TriSubChannelMesh language=cpp

!syntax parameters /TriSubChannelMesh/TriDuctMeshGenerator
!syntax parameters /Mesh/TriDuctMeshGenerator

!syntax inputs /TriSubChannelMesh/TriDuctMeshGenerator
!syntax inputs /Mesh/TriDuctMeshGenerator

!syntax children /TriSubChannelMesh/TriDuctMeshGenerator
!syntax children /Mesh/TriDuctMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
# TriInterWrapperMeshGenerator

!alert construction title=Undocumented Class
The TriInterWrapperMeshGenerator 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 /TriSubChannelMesh/TriInterWrapperMeshGenerator
!syntax description /Mesh/TriInterWrapperMeshGenerator

## Overview

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

This kernel creates the mesh were the `SCM` solution variables associated with the inter-wrapper live.

## Example Input File Syntax

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

!syntax parameters /TriSubChannelMesh/TriInterWrapperMeshGenerator
!syntax parameters /Mesh/TriInterWrapperMeshGenerator

!syntax inputs /TriSubChannelMesh/TriInterWrapperMeshGenerator
!syntax inputs /Mesh/TriInterWrapperMeshGenerator

!syntax children /TriSubChannelMesh/TriInterWrapperMeshGenerator
!syntax children /Mesh/TriInterWrapperMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
# TriPinMeshGenerator

!alert construction title=Undocumented Class
The TriPinMeshGenerator 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 /TriSubChannelMesh/TriPinMeshGenerator
!syntax description /Mesh/TriPinMeshGenerator

## Overview

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

This kernel creates the mesh were the `SCM` solution variables associated with the pins live.

## Example Input File Syntax

!! Describe and include an example of how to use the TriPinMeshGenerator object.
!listing /test/tests/problems/SFR/sodium-19pin/test19_monolithic.i block=TriSubChannelMesh language=cpp

!syntax parameters /TriSubChannelMesh/TriPinMeshGenerator
!syntax parameters /Mesh/TriPinMeshGenerator

!syntax inputs /TriSubChannelMesh/TriPinMeshGenerator
!syntax inputs /Mesh/TriPinMeshGenerator

!syntax children /TriSubChannelMesh/TriPinMeshGenerator
!syntax children /Mesh/TriPinMeshGenerator
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
# TriSubChannelMeshGenerator

!alert construction title=Undocumented Class
The TriSubChannelMeshGenerator 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 /TriSubChannelMesh/TriSubChannelMeshGenerator
!syntax description /Mesh/TriSubChannelMeshGenerator

## Overview

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

This kernel creates the mesh were the `SCM` solution variables associated with the subchannels live.

## Example Input File Syntax

!! Describe and include an example of how to use the TriSubChannelMeshGenerator object.
!listing /examples/Toshiba_37_pin/toshiba_37_pin.i block=TriSubChannelMesh language=cpp

!syntax parameters /TriSubChannelMesh/TriSubChannelMeshGenerator
!syntax parameters /Mesh/TriSubChannelMeshGenerator

!syntax inputs /TriSubChannelMesh/TriSubChannelMeshGenerator
!syntax inputs /Mesh/TriSubChannelMeshGenerator

!syntax children /TriSubChannelMesh/TriSubChannelMeshGenerator
!syntax children /Mesh/TriSubChannelMeshGenerator
Loading

0 comments on commit 3710d95

Please sign in to comment.