- schemeThe discretization and stabilization scheme that the nuclide system should use.
C++ Type:MooseEnum
Controllable:No
Description:The discretization and stabilization scheme that the nuclide system should use.
- temperatureThe temperature of the bulk fluid ($K$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The temperature of the bulk fluid ($K$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
TracerDepletionSystemAction
buildconstruction:Undocumented Action Class
The TracerDepletionSystemAction 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.
This action adds variables which represents the density of all mobile nuclides contained in the provided cross-section files, alongside the kernels required to describe the time evolution of those nuclides.
Overview
Example Input File Syntax
This action adds variables which represents the density of all mobile nuclides contained in the provided cross-section files, alongside the kernels required to describe the time evolution of those nuclides.
Input Parameters
- active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified only the blocks named will be visited and made active
- add_neutron_sourcesFalseIf group-wise radionuclide neutron source terms should be added.
Default:False
C++ Type:bool
Controllable:No
Description:If group-wise radionuclide neutron source terms should be added.
- add_photon_sourcesFalseIf group-wise radionuclide photon source terms should be added.
Default:False
C++ Type:bool
Controllable:No
Description:If group-wise radionuclide photon source terms should be added.
- blockThe list of blocks (ids or names) that this variable will be applied.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this variable will be applied.
- debug_filter_nuclidesA list of nuclides that should be included in the mobile depletion analysis.
C++ Type:std::vector<std::string>
Controllable:No
Description:A list of nuclides that should be included in the mobile depletion analysis.
- debug_verbositylevel1How verbose the debug output of the transport system should be. level0 is fully verbose. level1 outputs less debugging information.
Default:level1
C++ Type:MooseEnum
Controllable:No
Description:How verbose the debug output of the transport system should be. level0 is fully verbose. level1 outputs less debugging information.
- densityThe density of the bulk fluid ($g/cm^{3}$. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The density of the bulk fluid ($g/cm^{3}$. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- dynamic_viscosityThe dynamic viscosity of the bulk fluid ($g/(cm s)$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The dynamic viscosity of the bulk fluid ($g/(cm s)$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- element_number_densitiesThe number densities of each element in 'elements'. Must follow the same ordering as 'elements'.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The number densities of each element in 'elements'. Must follow the same ordering as 'elements'.
- elementsThe elemental composition of the fluid mixture. It is assumed that all elements added with this syntax are composed of a mixture of nuclides at their natural abundances.
C++ Type:std::vector<std::string>
Controllable:No
Description:The elemental composition of the fluid mixture. It is assumed that all elements added with this syntax are composed of a mixture of nuclides at their natural abundances.
- extra_nuclide_number_densitiesThe number densities of each nuclide in 'extra_nuclides'. Must follow the same ordering as 'extra_nuclides'.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The number densities of each nuclide in 'extra_nuclides'. Must follow the same ordering as 'extra_nuclides'.
- extra_nuclidesExtra nuclides to add to the composition of the fluid mixture.
C++ Type:std::vector<std::string>
Controllable:No
Description:Extra nuclides to add to the composition of the fluid mixture.
- familyLAGRANGESpecifies the family of FE shape functions to use for this variable.
Default:LAGRANGE
C++ Type:MooseEnum
Controllable:No
Description:Specifies the family of FE shape functions to use for this variable.
- fv_adv_interpolationaverageThe numerical scheme to use for interpolating nuclide scalar fields, as an advected quantity, to the face.
Default:average
C++ Type:MooseEnum
Controllable:No
Description:The numerical scheme to use for interpolating nuclide scalar fields, as an advected quantity, to the face.
- fv_face_interpolationaverageThe numerical scheme to interpolate the nuclide scalar field variables to the face (separate from the advected quantity interpolation).
Default:average
C++ Type:MooseEnum
Controllable:No
Description:The numerical scheme to interpolate the nuclide scalar field variables to the face (separate from the advected quantity interpolation).
- fv_two_term_boundary_expansionFalseWhether the simulation should use a two-term Taylor series expansion on the boundaries.
Default:False
C++ Type:bool
Controllable:No
Description:Whether the simulation should use a two-term Taylor series expansion on the boundaries.
- inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
- inlet_boundariesThe names of boundaries which act as inflow boundaries. GNAT applies a fixed nuclide number density at each of these boundaries equal to the initial number density specified in 'element_number_densities' and 'extra_nuclide_number_densities'. This functionality can be overriden by specifying inlet number densities in 'inlet_number_densities'.
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The names of boundaries which act as inflow boundaries. GNAT applies a fixed nuclide number density at each of these boundaries equal to the initial number density specified in 'element_number_densities' and 'extra_nuclide_number_densities'. This functionality can be overriden by specifying inlet number densities in 'inlet_number_densities'.
- inlet_number_densitiesA double vector of inlet number densities. The outer vector must match the ordering of 'inlet_boundaries'. The inner vector must must be arranged so elements go first; extra nuclides go second. The ordering of elements and nuclides must match the ordering of 'elements' and 'extra_nuclides'.
C++ Type:std::vector<std::vector<double>>
Unit:(no unit assumed)
Controllable:No
Description:A double vector of inlet number densities. The outer vector must match the ordering of 'inlet_boundaries'. The inner vector must must be arranged so elements go first; extra nuclides go second. The ordering of elements and nuclides must match the ordering of 'elements' and 'extra_nuclides'.
- mixing_lengthThe name of the mixing length functor. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the mixing length functor. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- neutron_group_boundaries2e+07 0 The neutron group structure in descending order of energy (including 0.0 eV)
Default:2e+07 0
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The neutron group structure in descending order of energy (including 0.0 eV)
- neutron_source_prefixneutron_sourceA prefix for the auxvariables which stores the group-wise neutron particle source.
Default:neutron_source
C++ Type:std::string
Controllable:No
Description:A prefix for the auxvariables which stores the group-wise neutron particle source.
- normalize_number_densitiesTrueWhether the number densities should be normalized such that the maximum number density is 1.0 (the true number densities are recalculated at the end of the simulation). This helps simulation convergence and stability greatly.
Default:True
C++ Type:bool
Controllable:No
Description:Whether the number densities should be normalized such that the maximum number density is 1.0 (the true number densities are recalculated at the end of the simulation). This helps simulation convergence and stability greatly.
- orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed).
Default:FIRST
C++ Type:MooseEnum
Controllable:No
Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed).
- outlet_boundariesThe names of boundaries which act as outflow boundaries. If 'using_moose_ns_fv' is set to 'true' this parameter will be ignored.
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The names of boundaries which act as outflow boundaries. If 'using_moose_ns_fv' is set to 'true' this parameter will be ignored.
- photon_group_boundaries2e+07 0 The photon group structure in descending order of energy (including 0.0 eV)
Default:2e+07 0
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The photon group structure in descending order of energy (including 0.0 eV)
- photon_source_prefixphoton_sourceA prefix for the auxvariables which stores the group-wise photon particle source.
Default:photon_source
C++ Type:std::string
Controllable:No
Description:A prefix for the auxvariables which stores the group-wise photon particle source.
- scaling1Specifies a scaling factor to apply to this variable.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Specifies a scaling factor to apply to this variable.
- schmidt_number0.7The turbulent Schmidt number that relates the turbulent scalar diffusivity to the turbulent momentum diffusivity.
Default:0.7
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The turbulent Schmidt number that relates the turbulent scalar diffusivity to the turbulent momentum diffusivity.
- transport_systemName of the transport system which will provide scalar fluxes.
C++ Type:std::string
Controllable:No
Description:Name of the transport system which will provide scalar fluxes.
- turbulence_handlingWhat type of turbulent diffusion to use.
C++ Type:MooseEnum
Controllable:No
Description:What type of turbulent diffusion to use.
- uThe functor name for the x-component of the velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The functor name for the x-component of the velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- using_moose_ns_fvFalseWhether the simulation should assume that the MOOSE Navier-Stokes module is being used for flow capabilities. This allows us to use more sophisticated stabilization schemes.
Default:False
C++ Type:bool
Controllable:No
Description:Whether the simulation should assume that the MOOSE Navier-Stokes module is being used for flow capabilities. This allows us to use more sophisticated stabilization schemes.
- vThe functor name for the y-component of the velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The functor name for the y-component of the velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- wThe functor name for the z-component of the velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The functor name for the z-component of the velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.