UncollidedFluxAction

buildconstruction:Undocumented Action Class

The UncollidedFluxAction 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.

An action which sets up an uncollided flux treatment using either the semi-analytical method of ray tracing, or the SASF-modified Shands-Hanopy-Morel technique.

Overview

Example Input File Syntax

An action which sets up an uncollided flux treatment using either the semi-analytical method of ray tracing, or the SASF-modified Shands-Hanopy-Morel technique.

Input Parameters

  • 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.

Required 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

  • 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_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

    Options:level0, level1

    Controllable:No

    Description:How verbose the debug output of the transport system should be. level0 is fully verbose. level1 outputs less debugging information.

  • familyLAGRANGESpecifies the family of FE shape functions to use for this variable.

    Default:LAGRANGE

    C++ Type:MooseEnum

    Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS

    Controllable:No

    Description:Specifies the family of FE shape functions to use for this variable.

  • 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.

  • is_conservative_transfer_srcTrueWhether 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:True

    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.

  • 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.

  • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed).

    Default:FIRST

    C++ Type:MooseEnum

    Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH

    Controllable:No

    Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed).

  • sasf_near_source_boundaryThe near-source boundary for mitigating singularities in the Self-Adjoint Scalar Flux approach.

    C++ Type:BoundaryName

    Controllable:No

    Description:The near-source boundary for mitigating singularities in the Self-Adjoint Scalar Flux approach.

  • sasf_near_source_cross_sectionsThe groupwise total cross-sections in the near-source region.

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The groupwise total cross-sections in the near-source region.

  • sasf_vacuum_boundariesThe implicit vacuum boundaries in the Self-Adjoint Scalar Flux approach.

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The implicit vacuum boundaries in the Self-Adjoint Scalar Flux approach.

  • 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.

  • uncollided_flux_moment_namesuncollided_flux_momentVariable names for the moments of the angular flux. The output format for the group flux moments will be of the form {uncollided_flux_moment_names}_g_l_m.

    Default:uncollided_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 {uncollided_flux_moment_names}_g_l_m.

Optional Parameters

  • 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'.

  • 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.

Boundary Sources 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

  • 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

  • rt_face_orderCONSTANTThe face quadrature rule order.

    Default:CONSTANT

    C++ Type:MooseEnum

    Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH, FIFTH, SIXTH, SEVENTH, EIGHTH, NINTH, TENTH, ELEVENTH, TWELFTH, THIRTEENTH, FOURTEENTH, FIFTEENTH, SIXTEENTH, SEVENTEENTH, EIGHTTEENTH, NINTEENTH, TWENTIETH

    Controllable:No

    Description:The face quadrature rule order.

  • rt_face_typeGAUSSThe face quadrature type.

    Default:GAUSS

    C++ Type:MooseEnum

    Options:GAUSS, GRID

    Controllable:No

    Description:The face quadrature type.

  • rt_n_azimuthal10Number of Chebyshev azimuthal quadrature points in a single octant of the unit sphere. Defaults to 30.

    Default:10

    C++ Type:unsigned int

    Controllable:No

    Description:Number of Chebyshev azimuthal quadrature points in a single octant of the unit sphere. Defaults to 30.

  • rt_n_polar10Number of Legendre polar quadrature points in a single octant of the unit sphere. Defaults to 30.

    Default:10

    C++ Type:unsigned int

    Controllable:No

    Description:Number of Legendre polar quadrature points in a single octant of the unit sphere. Defaults to 30.

  • rt_volume_orderCONSTANTThe volume quadrature rule order. For simplicity the same quadrature order is used for volumetric sources and target elements.

    Default:CONSTANT

    C++ Type:MooseEnum

    Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH, FIFTH, SIXTH, SEVENTH, EIGHTH, NINTH, TENTH, ELEVENTH, TWELFTH, THIRTEENTH, FOURTEENTH, FIFTEENTH, SIXTEENTH, SEVENTEENTH, EIGHTTEENTH, NINTEENTH, TWENTIETH

    Controllable:No

    Description:The volume quadrature rule order. For simplicity the same quadrature order is used for volumetric sources and target elements.

  • rt_volume_typeGAUSSThe volume quadrature type. For simplicity the same quadrature type is used for both volumetric sources and target elements.

    Default:GAUSS

    C++ Type:MooseEnum

    Options:GAUSS, GRID

    Controllable:No

    Description:The volume quadrature type. For simplicity the same quadrature type is used for both volumetric sources and target elements.

  • uncollided_flux_treatmentray-tracingThe type of uncollided flux treatment to apply to the solution. Options are a semi-analytical treatment using ray tracing or the Self-Adjoint Scalar Flux advection-reaction equation.

    Default:ray-tracing

    C++ Type:MooseEnum

    Options:ray-tracing, sasf

    Controllable:No

    Description:The type of uncollided flux treatment to apply to the solution. Options are a semi-analytical treatment using ray tracing or the Self-Adjoint Scalar Flux advection-reaction equation.

Ray Traced Uncollided Flux Treatment 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'.

Volumetric Source Parameters