diff --git a/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadInterWrapperMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadInterWrapperMeshGenerator.md index c190f9a17e92..d370e6641350 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadInterWrapperMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadInterWrapperMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadPinMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadPinMeshGenerator.md index 2ad02fe390fb..bbcfacdcdbf6 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadPinMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadPinMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadSubChannelMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadSubChannelMeshGenerator.md index a24eb1118f18..2d40e67f0a3e 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadSubChannelMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/DetailedQuadSubChannelMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/DetailedTriPinMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/DetailedTriPinMeshGenerator.md index 62f99c55b991..f4035398822f 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/DetailedTriPinMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/DetailedTriPinMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/DetailedTriSubChannelMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/DetailedTriSubChannelMeshGenerator.md index 52937fe12ae4..53123ab6a89b 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/DetailedTriSubChannelMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/DetailedTriSubChannelMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/QuadInterWrapperMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/QuadInterWrapperMeshGenerator.md index 6f554ed9aca6..627f64fc9cab 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/QuadInterWrapperMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/QuadInterWrapperMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/QuadPinMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/QuadPinMeshGenerator.md index 5e307fb6f138..9080045baacd 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/QuadPinMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/QuadPinMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/QuadSubChannelMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/QuadSubChannelMeshGenerator.md index 27d6a7b8e025..77072a99f44c 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/QuadSubChannelMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/QuadSubChannelMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/TriDuctMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/TriDuctMeshGenerator.md index 82255dc5832c..fb3b360dfe0c 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/TriDuctMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/TriDuctMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/TriInterWrapperMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/TriInterWrapperMeshGenerator.md index e3f74f1a21a3..5416caf09afc 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/TriInterWrapperMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/TriInterWrapperMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/TriPinMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/TriPinMeshGenerator.md index a8349f37c694..759d4418e4fd 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/TriPinMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/TriPinMeshGenerator.md @@ -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 diff --git a/modules/subchannel/doc/content/source/meshgenerators/TriSubChannelMeshGenerator.md b/modules/subchannel/doc/content/source/meshgenerators/TriSubChannelMeshGenerator.md index 3581f54a2031..79588d98e758 100644 --- a/modules/subchannel/doc/content/source/meshgenerators/TriSubChannelMeshGenerator.md +++ b/modules/subchannel/doc/content/source/meshgenerators/TriSubChannelMeshGenerator.md @@ -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 diff --git a/modules/subchannel/src/meshgenerators/DetailedQuadInterWrapperMeshGenerator.C b/modules/subchannel/src/meshgenerators/DetailedQuadInterWrapperMeshGenerator.C index 99cdaf0fc46f..6db987d90350 100644 --- a/modules/subchannel/src/meshgenerators/DetailedQuadInterWrapperMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/DetailedQuadInterWrapperMeshGenerator.C @@ -25,10 +25,12 @@ DetailedQuadInterWrapperMeshGenerator::validParams() { InputParameters params = MeshGenerator::validParams(); params.addClassDescription( - "Creates detailed mesh of inter-wrapper cells in a square lattice subchannel arrangement"); + "Creates a detailed mesh of the inter-wrapper cells around square lattice subassemblies"); params.addRequiredParam("assembly_pitch", "Assembly Pitch [m]"); - params.addRequiredParam("assembly_side_x", "Rod diameter [m]"); - params.addRequiredParam("assembly_side_y", "Rod diameter [m]"); + params.addRequiredParam("assembly_side_x", + "Outer side lengths of assembly in x [m] - including duct"); + params.addRequiredParam("assembly_side_y", + "Outer side lengths of assembly in y [m] - including duct"); params.addParam("unheated_length_entry", 0.0, "Unheated length at entry [m]"); params.addRequiredParam("heated_length", "Heated length [m]"); params.addParam("unheated_length_exit", 0.0, "Unheated length at exit [m]"); diff --git a/modules/subchannel/src/meshgenerators/DetailedQuadPinMeshGenerator.C b/modules/subchannel/src/meshgenerators/DetailedQuadPinMeshGenerator.C index 6d027e6d8d59..7988fcf14df5 100644 --- a/modules/subchannel/src/meshgenerators/DetailedQuadPinMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/DetailedQuadPinMeshGenerator.C @@ -22,7 +22,8 @@ InputParameters DetailedQuadPinMeshGenerator::validParams() { InputParameters params = DetailedPinMeshGeneratorBase::validParams(); - params.addClassDescription("Creates detailed mesh of fuel pins in a square lattice arrangement"); + params.addClassDescription( + "Creates a detailed mesh of fuel pins in a square lattice arrangement"); params.addRequiredParam("input", "The corresponding subchannel mesh"); params.addRequiredParam("nx", "Number of channels in the x direction [-]"); params.addRequiredParam("ny", "Number of channels in the y direction [-]"); diff --git a/modules/subchannel/src/meshgenerators/DetailedQuadSubChannelMeshGenerator.C b/modules/subchannel/src/meshgenerators/DetailedQuadSubChannelMeshGenerator.C index ae72420dfa9f..ee472083a990 100644 --- a/modules/subchannel/src/meshgenerators/DetailedQuadSubChannelMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/DetailedQuadSubChannelMeshGenerator.C @@ -25,7 +25,7 @@ DetailedQuadSubChannelMeshGenerator::validParams() { InputParameters params = MeshGenerator::validParams(); params.addClassDescription( - "Creates detailed mesh of subchannels in a square lattice arrangement"); + "Creates a detailed mesh of subchannels in a square lattice arrangement"); params.addRequiredParam("pitch", "Pitch [m]"); params.addRequiredParam("rod_diameter", "Rod diameter [m]"); params.addParam("unheated_length_entry", 0.0, "Unheated length at entry [m]"); @@ -34,7 +34,9 @@ DetailedQuadSubChannelMeshGenerator::validParams() params.addRequiredParam("n_cells", "The number of cells in the axial direction"); params.addRequiredParam("nx", "Number of channels in the x direction [-]"); params.addRequiredParam("ny", "Number of channels in the y direction [-]"); - params.addRequiredParam("gap", "Half of gap between assemblies [m]"); + params.addRequiredParam("gap", + "(Its an added distance between a perimetric pin and the duct: " + "Edge Pitch W = pitch/2 - rod_diameter/2 + gap) [m]"); params.addParam("block_id", 0, "Block ID used for the mesh subdomain."); return params; } diff --git a/modules/subchannel/src/meshgenerators/DetailedTriPinMeshGenerator.C b/modules/subchannel/src/meshgenerators/DetailedTriPinMeshGenerator.C index 63291e9a47b9..df67554b109b 100644 --- a/modules/subchannel/src/meshgenerators/DetailedTriPinMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/DetailedTriPinMeshGenerator.C @@ -23,7 +23,7 @@ DetailedTriPinMeshGenerator::validParams() { InputParameters params = DetailedPinMeshGeneratorBase::validParams(); params.addClassDescription( - "Creates detailed mesh of fuel pins in a triangular lattice arrangement"); + "Creates a detailed mesh of fuel pins in a triangular lattice arrangement"); params.addRequiredParam("input", "The corresponding subchannel mesh"); params.addRequiredParam("nrings", "Number of fuel rod rings per assembly [-]"); return params; diff --git a/modules/subchannel/src/meshgenerators/DetailedTriSubChannelMeshGenerator.C b/modules/subchannel/src/meshgenerators/DetailedTriSubChannelMeshGenerator.C index dbe20b5f0858..ca6bbfdd8484 100644 --- a/modules/subchannel/src/meshgenerators/DetailedTriSubChannelMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/DetailedTriSubChannelMeshGenerator.C @@ -26,7 +26,7 @@ DetailedTriSubChannelMeshGenerator::validParams() { InputParameters params = MeshGenerator::validParams(); params.addClassDescription( - "Creates detailed mesh of subchannels in a triangular lattice arrangement"); + "Creates a detailed mesh of subchannels in a triangular lattice arrangement"); params.addRequiredParam("pitch", "Pitch [m]"); params.addRequiredParam("rod_diameter", "Rod diameter [m]"); params.addParam("unheated_length_entry", 0.0, "Unheated length at entry [m]"); diff --git a/modules/subchannel/src/meshgenerators/QuadInterWrapperMeshGenerator.C b/modules/subchannel/src/meshgenerators/QuadInterWrapperMeshGenerator.C index 522c7bcf04c5..ae056e12deed 100644 --- a/modules/subchannel/src/meshgenerators/QuadInterWrapperMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/QuadInterWrapperMeshGenerator.C @@ -44,9 +44,8 @@ InputParameters QuadInterWrapperMeshGenerator::validParams() { InputParameters params = MeshGenerator::validParams(); - params.addClassDescription("Creates a mesh for the inter-wrapper in the location of the modeled " - "reactor section centroid"); - params.addRequiredParam("assembly_pitch", "Pitch [m]"); + params.addClassDescription("Creates a mesh for the inter-wrapper around square subassemblies"); + params.addRequiredParam("assembly_pitch", "Assembly Pitch [m]"); params.addRequiredParam("assembly_side_x", "Outer side lengths of assembly in x [m] - including duct"); params.addRequiredParam("assembly_side_y", diff --git a/modules/subchannel/src/meshgenerators/QuadSubChannelMeshGenerator.C b/modules/subchannel/src/meshgenerators/QuadSubChannelMeshGenerator.C index 2088ff2d82e1..068cf5eb4a40 100644 --- a/modules/subchannel/src/meshgenerators/QuadSubChannelMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/QuadSubChannelMeshGenerator.C @@ -72,7 +72,9 @@ QuadSubChannelMeshGenerator::validParams() params.addRequiredParam("n_cells", "The number of cells in the axial direction"); params.addRequiredParam("nx", "Number of channels in the x direction [-]"); params.addRequiredParam("ny", "Number of channels in the y direction [-]"); - params.addRequiredParam("gap", "(Edge Pitch W = pitch/2 - rod_diameter/2 + gap) [m]"); + params.addRequiredParam("gap", + "(Its an added distance between a perimetric pin and the duct: " + "Edge Pitch W = pitch/2 - rod_diameter/2 + gap) [m]"); params.addParam("block_id", 0, "Domain Index"); return params; } @@ -117,14 +119,14 @@ QuadSubChannelMeshGenerator::QuadSubChannelMeshGenerator(const InputParameters & if (*max_element(_reduction_blockage.begin(), _reduction_blockage.end()) > 1) mooseError(name(), ": The area reduction of the blocked subchannels cannot be more than 1"); - if ((_index_blockage.size() > _nx * _ny) | (_reduction_blockage.size() > _nx * _ny) | + if ((_index_blockage.size() > _nx * _ny) || (_reduction_blockage.size() > _nx * _ny) || (_k_blockage.size() > _nx * _ny)) mooseError(name(), ": Size of vectors: index_blockage, reduction_blockage, k_blockage, cannot be more " "than the total number of subchannels"); - if ((_index_blockage.size() != _reduction_blockage.size()) | - (_index_blockage.size() != _k_blockage.size()) | + if ((_index_blockage.size() != _reduction_blockage.size()) || + (_index_blockage.size() != _k_blockage.size()) || (_reduction_blockage.size() != _k_blockage.size())) mooseError(name(), ": Size of vectors: index_blockage, reduction_blockage, k_blockage, must be equal " diff --git a/modules/subchannel/src/meshgenerators/TriDuctMeshGenerator.C b/modules/subchannel/src/meshgenerators/TriDuctMeshGenerator.C index 01b34a3e2a88..a543c71cd38d 100644 --- a/modules/subchannel/src/meshgenerators/TriDuctMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/TriDuctMeshGenerator.C @@ -25,7 +25,7 @@ TriDuctMeshGenerator::validParams() { InputParameters params = MeshGenerator::validParams(); params.addClassDescription( - "Creates a mesh of 1D duct cells around a triangular lattice subchannel arrangement"); + "Creates a mesh of 1D duct cells around a triangular lattice subassembly"); params.addRequiredParam("input", "The corresponding subchannel mesh"); params.addParam("block_id", 2, "Domain Index"); params.addRequiredParam("n_cells", "The number of cells in the axial direction"); diff --git a/modules/subchannel/src/meshgenerators/TriInterWrapperMeshGenerator.C b/modules/subchannel/src/meshgenerators/TriInterWrapperMeshGenerator.C index 7e64d0e34217..9167c75c9a99 100644 --- a/modules/subchannel/src/meshgenerators/TriInterWrapperMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/TriInterWrapperMeshGenerator.C @@ -24,8 +24,8 @@ InputParameters TriInterWrapperMeshGenerator::validParams() { InputParameters params = MeshGenerator::validParams(); - params.addClassDescription("Creates a mesh of 1D inter-wrapper cells around a triangular lattice " - "subchannel arrangement"); + params.addClassDescription( + "Creates a mesh for the inter-wrapper around triangular subassemblies"); params.addRequiredParam("n_cells", "The number of cells in the axial direction"); params.addRequiredParam("assembly_pitch", "Pitch [m]"); params.addParam("unheated_length_entry", 0.0, "Unheated length at entry [m]"); diff --git a/modules/subchannel/src/meshgenerators/TriPinMeshGenerator.C b/modules/subchannel/src/meshgenerators/TriPinMeshGenerator.C index 39f069292af3..e10a4cb96b36 100644 --- a/modules/subchannel/src/meshgenerators/TriPinMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/TriPinMeshGenerator.C @@ -45,7 +45,7 @@ TriPinMeshGenerator::validParams() { InputParameters params = MeshGenerator::validParams(); params.addRequiredParam("input", "The corresponding subchannel mesh"); - params.addClassDescription("Creates a fuel pin mesh in a triangular lattice arrangement"); + params.addClassDescription("Creates a mesh of 1D fuel pins in a triangular lattice arrangement"); params.addParam("unheated_length_entry", 0.0, "Unheated length at entry [m]"); params.addRequiredParam("heated_length", "Heated length [m]"); params.addParam("unheated_length_exit", 0.0, "Unheated length at exit [m]"); diff --git a/modules/subchannel/src/meshgenerators/TriSubChannelMeshGenerator.C b/modules/subchannel/src/meshgenerators/TriSubChannelMeshGenerator.C index eb18af6dc0db..71f46d8e21d1 100644 --- a/modules/subchannel/src/meshgenerators/TriSubChannelMeshGenerator.C +++ b/modules/subchannel/src/meshgenerators/TriSubChannelMeshGenerator.C @@ -24,7 +24,8 @@ InputParameters TriSubChannelMeshGenerator::validParams() { InputParameters params = MeshGenerator::validParams(); - params.addClassDescription("Creates a subchannel mesh in a triangular lattice arrangement"); + params.addClassDescription( + "Creates a mesh of 1D subchannels in a triangular lattice arrangement"); params.addRequiredParam("n_cells", "The number of cells in the axial direction"); params.addRequiredParam("pitch", "Pitch [m]"); params.addRequiredParam("rod_diameter", "Rod diameter [m]"); @@ -93,8 +94,8 @@ TriSubChannelMeshGenerator::TriSubChannelMeshGenerator(const InputParameters & p if (*max_element(_reduction_blockage.begin(), _reduction_blockage.end()) > 1) mooseError(name(), ": The area reduction of the blocked subchannels cannot be more than 1"); - if ((_index_blockage.size() != _reduction_blockage.size()) | - (_index_blockage.size() != _k_blockage.size()) | + if ((_index_blockage.size() != _reduction_blockage.size()) || + (_index_blockage.size() != _k_blockage.size()) || (_reduction_blockage.size() != _k_blockage.size())) mooseError(name(), ": Size of vectors: index_blockage, reduction_blockage, k_blockage, must be equal " @@ -175,7 +176,7 @@ TriSubChannelMeshGenerator::TriSubChannelMeshGenerator(const InputParameters & p ": The index of the blocked subchannel cannot be more than the max index of the " "subchannels"); - if ((_index_blockage.size() > _n_channels) | (_reduction_blockage.size() > _n_channels) | + if ((_index_blockage.size() > _n_channels) || (_reduction_blockage.size() > _n_channels) || (_k_blockage.size() > _n_channels)) mooseError(name(), ": Size of vectors: index_blockage, reduction_blockage, k_blockage, cannot be more "