- 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.
- num_groupsThe number of spectral energy groups in the problem.
C++ Type:unsigned int
Controllable:No
Description:The number of spectral energy groups in the problem.
- 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).
- particle_typeThe type of particle to be consuming material property data.
C++ Type:MooseEnum
Controllable:No
Description:The type of particle to be consuming material property data.
- schemeThe discretization and stabilization scheme for the transport equation.
C++ Type:MooseEnum
Controllable:No
Description:The discretization and stabilization scheme for the transport equation.
TransportAction
buildconstruction:Undocumented Action Class
The TransportAction 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 all of the required variables, kernels, boundary conditions, initial conditions and auxiliary systems required to solve source-driven multi-group neutral particle transport problems with Gnat.
Overview
Example Input File Syntax
This action adds all of the required variables, kernels, boundary conditions, initial conditions and auxiliary systems required to solve source-driven multi-group neutral particle transport problems with Gnat.
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
- 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.
Optional Parameters
- angular_flux_namesangular_fluxVariable names for the angular flux. The output format for the group angular fluxes will be of the form {angular_flux_names}_g_n.
Default:angular_flux
C++ Type:std::string
Controllable:No
Description:Variable names for the angular flux. The output format for the group angular fluxes will be of the form {angular_flux_names}_g_n.
- flux_moment_namesflux_momentVariable names for the moments of the angular flux. The output format for the group flux moments will be of the form {flux_moment_names}_g_l_m.
Default:flux_moment
C++ Type:std::string
Controllable:No
Description:Variable names for the moments of the angular flux. The output format for the group flux moments will be of the form {flux_moment_names}_g_l_m.
- output_angular_fluxesFalseWhether the angular flux ordinates should be written to the exodus file or not.
Default:False
C++ Type:bool
Controllable:No
Description:Whether the angular flux ordinates should be written to the exodus file or not.
- 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.
Variable Parameters
- 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.
- eigenFalseWhether or not the transport simulation should prepare for an eigenvalue calculation. This parameters is only valid for steady-state simulations with the particle type set to 'neutron'. This parameter is ignored otherwise.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not the transport simulation should prepare for an eigenvalue calculation. This parameters is only valid for steady-state simulations with the particle type set to 'neutron'. This parameter is ignored otherwise.
- init_from_fileFalseIf the simulation should be initialized from a file or not.
Default:False
C++ Type:bool
Controllable:No
Description:If the simulation should be initialized from a file or not.
- max_anisotropy0The maximum degree of anisotropy to evaluate. Defaults to 0 for isotropic scattering.
Default:0
C++ Type:unsigned int
Controllable:No
Description:The maximum degree of anisotropy to evaluate. Defaults to 0 for isotropic scattering.
- use_scattering_jacobiansFalseWhether or not to use hand-coded scattering Jacobians.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to use hand-coded scattering Jacobians.
Simulation Parameters
- boundary_current_anisotropyThe degree of anisotropy to be applied to the boundary currents. The vector must correspond with the surface current boundary conditions provided in 'current_boundaries'.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:The degree of anisotropy to be applied to the boundary currents. The vector must correspond with the surface current boundary conditions provided in 'current_boundaries'.
- boundary_currentsA double vector containing the external currents for all boundaries. The exterior vector must correspond with the surface current boundary conditions provided in 'current_boundaries'.
C++ Type:std::vector<std::vector<double>>
Unit:(no unit assumed)
Controllable:No
Description:A double vector containing the external currents for all boundaries. The exterior vector must correspond with the surface current boundary conditions provided in 'current_boundaries'.
- boundary_source_anisotropyThe degree of anisotropy of the boundary source moments. The exterior vector must correspond with the surface source boundary conditions provided in 'source_boundaries'.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:The degree of anisotropy of the boundary source moments. The exterior vector must correspond with the surface source boundary conditions provided in 'source_boundaries'.
- boundary_source_momentsA double vector containing the external source moments for all boundaries. The exterior vector must correspond with the surface source boundary conditions provided in 'source_boundaries'.
C++ Type:std::vector<std::vector<double>>
Unit:(no unit assumed)
Controllable:No
Description:A double vector containing the external source moments for all boundaries. The exterior vector must correspond with the surface source boundary conditions provided in 'source_boundaries'.
- current_boundariesThe boundaries to apply the current boundary conditions to. This is a specialization of the source boundary condition for a particle direction equal to the surface normal.
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The boundaries to apply the current boundary conditions to. This is a specialization of the source boundary condition for a particle direction equal to the surface normal.
- reflective_boundariesThe boundaries to apply reflective boundary conditions.
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The boundaries to apply reflective boundary conditions.
- source_boundariesThe boundaries to apply incoming flux boundary conditions.
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The boundaries to apply incoming flux boundary conditions.
- vacuum_boundariesThe boundaries to apply vacuum boundary conditions.
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The boundaries to apply vacuum boundary conditions.
Boundary Condition Parameters
- constant_ic0 A constant initial condition for the angular fluxes.
Default:0
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:A constant initial condition for the angular fluxes.
- ic_typeconstantThe type of initial condition to use (if multiple are provided). Defaults to constant initial conditions.
Default:constant
C++ Type:MooseEnum
Controllable:No
Description:The type of initial condition to use (if multiple are provided). Defaults to constant initial conditions.
Initial Condition 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.
Advanced Parameters
- debug_disable_fissionTrueDebug option to disable fission evaluation.
Default:True
C++ Type:bool
Controllable:No
Description:Debug option to disable fission evaluation.
- debug_disable_scatteringFalseDebug option to disable scattering evaluation.
Default:False
C++ Type:bool
Controllable:No
Description:Debug option to disable scattering evaluation.
- debug_disable_source_iterationTrueDebug option to disable source iteration.
Default:True
C++ Type:bool
Controllable:No
Description:Debug option to disable source iteration.
- 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.
Debugging Parameters
- field_source_anisotropiesThe anisotropies of the field sources. The vector should correspond with the order of 'field_source_locations'.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:The anisotropies of the field sources. The vector should correspond with the order of 'field_source_locations'.
- field_source_blocksThe list of blocks (ids or names) that host a field source.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that host a field source.
- field_source_momentsA double vector containing a list of external source moments for all field particle sources. The external vector should correspond with the order of 'field_source_locations'.
C++ Type:std::vector<std::vector<VariableName>>
Unit:(no unit assumed)
Controllable:No
Description:A double vector containing a list of external source moments for all field particle sources. The external vector should correspond with the order of 'field_source_locations'.
- field_source_scalingScaling factors to apply to field radiation sources. The vector should correspond with the order of 'field_source_locations'.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Scaling factors to apply to field radiation sources. The vector should correspond with the order of 'field_source_locations'.
Field Source Parameters
- from_blocksThe list of blocks (ids or names) that we are pulling from.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that we are pulling from.
- from_flux_moment_namesflux_momentThe names of the source flux moments.
Default:flux_moment
C++ Type:std::string
Controllable:No
Description:The names of the source flux moments.
- from_multi_appThe name of the multi-app to pull the source flux moments.
C++ Type:MultiAppName
Controllable:No
Description:The name of the multi-app to pull the source flux moments.
- is_conservative_transfer_srcFalseWhether this transport action is providing flux moments to a sub/parent app using conservative transfers. Setting this option to 'true' adds post-processors to ensure flux moments are conservative.
Default:False
C++ Type:bool
Controllable:No
Description:Whether this transport action is providing flux moments to a sub/parent app using conservative transfers. Setting this option to 'true' adds post-processors to ensure flux moments are conservative.
- transfer_to_fvFalseWhether the transfer variable should be a finite volume variable or not. Useful for coupling to finite volume fields.
Default:False
C++ Type:bool
Controllable:No
Description:Whether the transfer variable should be a finite volume variable or not. Useful for coupling to finite volume fields.
- use_conservative_transfersTrueWhether this transport action should pull flux moments using conservative transfers.
Default:True
C++ Type:bool
Controllable:No
Description:Whether this transport action should pull flux moments using conservative transfers.
- use_copyFalseWhether a MultiAppCopyTransfer should be used for the transfer scheme or not.
Default:False
C++ Type:bool
Controllable:No
Description:Whether a MultiAppCopyTransfer should be used for the transfer scheme or not.
Multiapp Parameters
- from_uncollided_flux_moment_namesuncollided_flux_momentThe names of the source flux moments.
Default:uncollided_flux_moment
C++ Type:std::string
Controllable:No
Description:The names of the source flux moments.
- uncollided_from_blocksThe list of blocks (ids or names) that we are pulling from.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that we are pulling from.
- uncollided_from_multi_appThe name of the multi-app to pull the uncollided flux moments.
C++ Type:MultiAppName
Controllable:No
Description:The name of the multi-app to pull the uncollided flux moments.
- use_conservative_uncollided_transfersTrueWhether the uncollided flux moments should be conserved when transferred to the new shape functions.
Default:True
C++ Type:bool
Controllable:No
Description:Whether the uncollided flux moments should be conserved when transferred to the new shape functions.
Uncollided Multiapp Parameters
- major_axisxMajor axis of the angular quadrature. Allows the polar angular quadrature to align with a cartesian axis with minimal heterogeneity. Default is the x-axis. This parameter is only applied in 3D cartesian problems.
Default:x
C++ Type:MooseEnum
Controllable:No
Description:Major axis of the angular quadrature. Allows the polar angular quadrature to align with a cartesian axis with minimal heterogeneity. Default is the x-axis. This parameter is only applied in 3D cartesian problems.
- n_azimuthal3Number of Chebyshev azimuthal quadrature points in a single octant of the unit sphere. Defaults to 3.
Default:3
C++ Type:unsigned int
Controllable:No
Description:Number of Chebyshev azimuthal quadrature points in a single octant of the unit sphere. Defaults to 3.
- n_polar3Number of Legendre polar quadrature points in a single octant of the unit sphere. Defaults to 3.
Default:3
C++ Type:unsigned int
Controllable:No
Description:Number of Legendre polar quadrature points in a single octant of the unit sphere. Defaults to 3.
Quadrature Parameters
- point_source_anisotropiesThe anisotropies of the point sources. The vector should correspond with the order of 'point_source_locations'
C++ Type:std::vector<unsigned int>
Controllable:No
Description:The anisotropies of the point sources. The vector should correspond with the order of 'point_source_locations'
- point_source_locationsThe locations of all isotropic point sources in the problem space.
C++ Type:std::vector<libMesh::Point>
Controllable:No
Description:The locations of all isotropic point sources in the problem space.
- point_source_momentsA double vector containing a list of external source moments for all point particle sources. The external vector should correspond with the order of 'point_source_locations'.
C++ Type:std::vector<std::vector<double>>
Unit:(no unit assumed)
Controllable:No
Description:A double vector containing a list of external source moments for all point particle sources. The external vector should correspond with the order of 'point_source_locations'.
Point Source Parameters
- scale_sourcesFalseIf the external fixed sources should be scaled such that each source moment is divided by the maximum source moment.
Default:False
C++ Type:bool
Controllable:No
Description:If the external fixed sources should be scaled such that each source moment is divided by the maximum source moment.
Fixed Source Parameters
- volumetric_source_anisotropiesThe anisotropies of the volumetric sources. The vector should correspond with the order of 'volumetric_source_blocks'
C++ Type:std::vector<unsigned int>
Controllable:No
Description:The anisotropies of the volumetric sources. The vector should correspond with the order of 'volumetric_source_blocks'
- volumetric_source_blocksThe list of blocks (ids or names) that host a volumetric source.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that host a volumetric source.
- volumetric_source_momentsA double vector containing a list of external source moments for all volumetric particle sources. The external vector should correspond with the order of 'volumetric_source_blocks'.
C++ Type:std::vector<std::vector<double>>
Unit:(no unit assumed)
Controllable:No
Description:A double vector containing a list of external source moments for all volumetric particle sources. The external vector should correspond with the order of 'volumetric_source_blocks'.