From 5db4455f770be80ad46509a2fa2e5a316e456aca Mon Sep 17 00:00:00 2001 From: Nathan Glaser Date: Sun, 16 Jun 2024 19:02:14 -0500 Subject: [PATCH 1/6] Add preliminary, brief documentation to NtAction --- doc/content/source/actions/NtAction.md | 100 +++++++++++++++++++++++-- 1 file changed, 94 insertions(+), 6 deletions(-) diff --git a/doc/content/source/actions/NtAction.md b/doc/content/source/actions/NtAction.md index c83824310f..b09f9263bd 100644 --- a/doc/content/source/actions/NtAction.md +++ b/doc/content/source/actions/NtAction.md @@ -1,16 +1,104 @@ # NtAction -!alert construction title=Undocumented Action Class -The NtAction 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 an Action; -however, what is contained is ultimately determined by what is necessary to make the documentation -clear for users. +!alert warning +This action sets up ONLY the variables and kernels for neutron diffusion, NOT the variables and kernels for precursor tracking. +To generate the precursor variables and kernels, see [PrecursorAction](PrecursorAction.md). !syntax description /Nt/NtAction ## Overview -!! Replace these lines with information regarding the NtAction action. ++NtAction+ greatly reduces input file length and complexity by internally generating diffusion variables and kernels. +When including only the required input parameters, this action constructs the neutron group variables and their associated kernels: +[SigmaR](SigmaR.md), [GroupDiffusion](GroupDiffusion.md), [InScatter](InScatter.md), and [CoupledFissionKernel](CoupledFissionKernel.md). +With 'account_delayed' set to +True+, [DelayedNeutronSource](DelayedNeutronSource.md) is also constructed, otherwise this kernel is not constructed and the simulation does not consider the delayed neutron precursor effects on the neutron flux distributions. + +An example input file without the +NtAction+, showing only the portion affected by the action: + +```language=text +[Variables] + [group1] + order = FIRST + family = LAGRANGE + [] + [group2] + order = FIRST + family = LAGRANGE + [] +[] + +[Kernels] + #--------------------------------------------------------------------- + # Group 1 Neutronics + #--------------------------------------------------------------------- + [sigma_r_group1] + type = SigmaR + variable = group1 + group_number = 1 + [] + [diff_group1] + type = GroupDiffusion + variable = group1 + group_number = 1 + [] + [inscatter_group1] + type = InScatter + variable = group1 + group_number = 1 + [] + [fission_source_group1] + type = CoupledFissionKernel + variable = group1 + group_number = 1 + block = '0' + extra_vector_tags = 'eigen' + [] + [delayed_group1] + type = DelayedNeutronSource + variable = group1 + block = '0' + group_number = 1 + [] + + #--------------------------------------------------------------------- + # Group 2 Neutronics + #--------------------------------------------------------------------- + [sigma_r_group2] + type = SigmaR + variable = group2 + group_number = 2 + [] + [diff_group2] + type = GroupDiffusion + variable = group2 + group_number = 2 + [] + [fission_source_group2] + type = CoupledFissionKernel + variable = group2 + group_number = 2 + block = '0' + extra_vector_tags = 'eigen' + [] + [inscatter_group2] + type = InScatter + variable = group2 + group_number = 2 + [] +[] +``` + +And then the same variables and kernels created with the +NtAction+: + +```language=text +[Nt] + var_name_base = group + vacuum_boundaries = 'fuel_bottom mod_bottom right fuel_top mod_top' + pre_blocks = '0' + create_temperature_var = false + eigen = true +[] +``` ## Example Input File Syntax From 8fe92cc4a8600a227baf804de1ae387d178c046a Mon Sep 17 00:00:00 2001 From: Nathan Glaser Date: Mon, 17 Jun 2024 13:25:17 -0500 Subject: [PATCH 2/6] Fix sample input location in md file --- doc/content/source/actions/NtAction.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/content/source/actions/NtAction.md b/doc/content/source/actions/NtAction.md index b09f9263bd..1c534d465e 100644 --- a/doc/content/source/actions/NtAction.md +++ b/doc/content/source/actions/NtAction.md @@ -13,6 +13,8 @@ When including only the required input parameters, this action constructs the ne [SigmaR](SigmaR.md), [GroupDiffusion](GroupDiffusion.md), [InScatter](InScatter.md), and [CoupledFissionKernel](CoupledFissionKernel.md). With 'account_delayed' set to +True+, [DelayedNeutronSource](DelayedNeutronSource.md) is also constructed, otherwise this kernel is not constructed and the simulation does not consider the delayed neutron precursor effects on the neutron flux distributions. +## Example Input File Syntax + An example input file without the +NtAction+, showing only the portion affected by the action: ```language=text @@ -100,8 +102,6 @@ And then the same variables and kernels created with the +NtAction+: [] ``` -## Example Input File Syntax - !! Describe and include an example of how to use the NtAction action. !syntax description /Nt/NtAction From 00ec023a95b00cabbbf76e863f1e5ee0c5acbcac Mon Sep 17 00:00:00 2001 From: Nathan Glaser Date: Mon, 17 Jun 2024 13:32:35 -0500 Subject: [PATCH 3/6] Add reference to tutorial page --- doc/content/source/actions/NtAction.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/content/source/actions/NtAction.md b/doc/content/source/actions/NtAction.md index 1c534d465e..763389a1c7 100644 --- a/doc/content/source/actions/NtAction.md +++ b/doc/content/source/actions/NtAction.md @@ -13,6 +13,8 @@ When including only the required input parameters, this action constructs the ne [SigmaR](SigmaR.md), [GroupDiffusion](GroupDiffusion.md), [InScatter](InScatter.md), and [CoupledFissionKernel](CoupledFissionKernel.md). With 'account_delayed' set to +True+, [DelayedNeutronSource](DelayedNeutronSource.md) is also constructed, otherwise this kernel is not constructed and the simulation does not consider the delayed neutron precursor effects on the neutron flux distributions. +For more information regarding the use of +NtAction+ please refer to the tutorials located [here](tutorials.md), specifically the +Multiphysics Reactor Simulations+ section. + ## Example Input File Syntax An example input file without the +NtAction+, showing only the portion affected by the action: From 1cf202b0e13fcf045f01bb58c67d3066950d0eb6 Mon Sep 17 00:00:00 2001 From: Nathan Glaser Date: Tue, 18 Jun 2024 14:28:55 -0500 Subject: [PATCH 4/6] Address initial comments and feedback --- doc/content/source/actions/NtAction.md | 105 ++++--------------------- 1 file changed, 15 insertions(+), 90 deletions(-) diff --git a/doc/content/source/actions/NtAction.md b/doc/content/source/actions/NtAction.md index 763389a1c7..bdbf3a590a 100644 --- a/doc/content/source/actions/NtAction.md +++ b/doc/content/source/actions/NtAction.md @@ -1,110 +1,35 @@ # NtAction -!alert warning -This action sets up ONLY the variables and kernels for neutron diffusion, NOT the variables and kernels for precursor tracking. -To generate the precursor variables and kernels, see [PrecursorAction](PrecursorAction.md). +!alert note +This action sets up ONLY the variables, kernels, and BCs for neutron diffusion, NOT the variables, kernels, and BCs for precursor tracking. +To generate these, see [PrecursorAction](PrecursorAction.md). !syntax description /Nt/NtAction ## Overview -+NtAction+ greatly reduces input file length and complexity by internally generating diffusion variables and kernels. +```NtAction``` greatly reduces input file length and complexity by automatically setting up variables, kernels, and BCs for the neutron diffusion equations. When including only the required input parameters, this action constructs the neutron group variables and their associated kernels: [SigmaR](SigmaR.md), [GroupDiffusion](GroupDiffusion.md), [InScatter](InScatter.md), and [CoupledFissionKernel](CoupledFissionKernel.md). -With 'account_delayed' set to +True+, [DelayedNeutronSource](DelayedNeutronSource.md) is also constructed, otherwise this kernel is not constructed and the simulation does not consider the delayed neutron precursor effects on the neutron flux distributions. +With ```account_delayed``` set to ```True```, [DelayedNeutronSource](DelayedNeutronSource.md) is also constructed, +otherwise this kernel is not constructed and the simulation does not consider +the delayed neutron precursor effects on the neutron flux distributions. -For more information regarding the use of +NtAction+ please refer to the tutorials located [here](tutorials.md), specifically the +Multiphysics Reactor Simulations+ section. +For more information regarding the use of ```NtAction``` please refer to the tutorials located [here](tutorials.md), +specifically the +Multiphysics Reactor Simulations+ section. ## Example Input File Syntax -An example input file without the +NtAction+, showing only the portion affected by the action: +An example input file without the ```NtAction```, showing only the portion affected by the action: -```language=text -[Variables] - [group1] - order = FIRST - family = LAGRANGE - [] - [group2] - order = FIRST - family = LAGRANGE - [] -[] +!listing tutorial/eigenvalue/nts.i + start=Variables end=Materials remove=Precursors -[Kernels] - #--------------------------------------------------------------------- - # Group 1 Neutronics - #--------------------------------------------------------------------- - [sigma_r_group1] - type = SigmaR - variable = group1 - group_number = 1 - [] - [diff_group1] - type = GroupDiffusion - variable = group1 - group_number = 1 - [] - [inscatter_group1] - type = InScatter - variable = group1 - group_number = 1 - [] - [fission_source_group1] - type = CoupledFissionKernel - variable = group1 - group_number = 1 - block = '0' - extra_vector_tags = 'eigen' - [] - [delayed_group1] - type = DelayedNeutronSource - variable = group1 - block = '0' - group_number = 1 - [] - #--------------------------------------------------------------------- - # Group 2 Neutronics - #--------------------------------------------------------------------- - [sigma_r_group2] - type = SigmaR - variable = group2 - group_number = 2 - [] - [diff_group2] - type = GroupDiffusion - variable = group2 - group_number = 2 - [] - [fission_source_group2] - type = CoupledFissionKernel - variable = group2 - group_number = 2 - block = '0' - extra_vector_tags = 'eigen' - [] - [inscatter_group2] - type = InScatter - variable = group2 - group_number = 2 - [] -[] -``` +And then the same information created with the ```NtAction```: -And then the same variables and kernels created with the +NtAction+: - -```language=text -[Nt] - var_name_base = group - vacuum_boundaries = 'fuel_bottom mod_bottom right fuel_top mod_top' - pre_blocks = '0' - create_temperature_var = false - eigen = true -[] -``` - -!! Describe and include an example of how to use the NtAction action. +!listing tutorial/eigenvalue/nts-action.i + block=Nt !syntax description /Nt/NtAction From f54db80620ae20a6842a5c4d2eb9f37ae3f80a36 Mon Sep 17 00:00:00 2001 From: Nathan Glaser Date: Tue, 18 Jun 2024 15:08:55 -0500 Subject: [PATCH 5/6] Fix line lengths to be under 100 characters --- doc/content/source/actions/NtAction.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/doc/content/source/actions/NtAction.md b/doc/content/source/actions/NtAction.md index bdbf3a590a..65faac4c94 100644 --- a/doc/content/source/actions/NtAction.md +++ b/doc/content/source/actions/NtAction.md @@ -1,26 +1,33 @@ # NtAction !alert note -This action sets up ONLY the variables, kernels, and BCs for neutron diffusion, NOT the variables, kernels, and BCs for precursor tracking. +This action sets up ONLY the variables, kernels, and BCs for neutron diffusion, +NOT the variables, kernels, and BCs for precursor tracking. To generate these, see [PrecursorAction](PrecursorAction.md). !syntax description /Nt/NtAction ## Overview -```NtAction``` greatly reduces input file length and complexity by automatically setting up variables, kernels, and BCs for the neutron diffusion equations. -When including only the required input parameters, this action constructs the neutron group variables and their associated kernels: -[SigmaR](SigmaR.md), [GroupDiffusion](GroupDiffusion.md), [InScatter](InScatter.md), and [CoupledFissionKernel](CoupledFissionKernel.md). -With ```account_delayed``` set to ```True```, [DelayedNeutronSource](DelayedNeutronSource.md) is also constructed, +```NtAction``` greatly reduces input file length and complexity by automatically +setting up variables, kernels, and BCs for the neutron diffusion equations. +When including only the required input parameters, this action constructs the +neutron group variables and their associated kernels: +[SigmaR](SigmaR.md), [GroupDiffusion](GroupDiffusion.md), +[InScatter](InScatter.md), and [CoupledFissionKernel](CoupledFissionKernel.md). +With ```account_delayed``` set to ```True```, +[DelayedNeutronSource](DelayedNeutronSource.md) is also constructed, otherwise this kernel is not constructed and the simulation does not consider the delayed neutron precursor effects on the neutron flux distributions. -For more information regarding the use of ```NtAction``` please refer to the tutorials located [here](tutorials.md), -specifically the +Multiphysics Reactor Simulations+ section. +For more information regarding the use of ```NtAction``` please refer to the +tutorials located [here](tutorials.md), specifically the +Multiphysics Reactor +Simulations+ section. ## Example Input File Syntax -An example input file without the ```NtAction```, showing only the portion affected by the action: +An example input file without the ```NtAction```, showing only the portion +affected by the action: !listing tutorial/eigenvalue/nts.i start=Variables end=Materials remove=Precursors From 188b2184477a38cded45fa8e117e14717bb319f2 Mon Sep 17 00:00:00 2001 From: Nathan Glaser Date: Tue, 18 Jun 2024 15:32:37 -0500 Subject: [PATCH 6/6] Fix line endings --- doc/content/source/actions/NtAction.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/content/source/actions/NtAction.md b/doc/content/source/actions/NtAction.md index 65faac4c94..0a47fd8c82 100644 --- a/doc/content/source/actions/NtAction.md +++ b/doc/content/source/actions/NtAction.md @@ -2,7 +2,7 @@ !alert note This action sets up ONLY the variables, kernels, and BCs for neutron diffusion, -NOT the variables, kernels, and BCs for precursor tracking. +NOT the variables, kernels, and BCs for precursor tracking. To generate these, see [PrecursorAction](PrecursorAction.md). !syntax description /Nt/NtAction @@ -29,11 +29,11 @@ Simulations+ section. An example input file without the ```NtAction```, showing only the portion affected by the action: -!listing tutorial/eigenvalue/nts.i +!listing tutorial/eigenvalue/nts.i start=Variables end=Materials remove=Precursors -And then the same information created with the ```NtAction```: +And then the same information created with the ```NtAction```: !listing tutorial/eigenvalue/nts-action.i block=Nt