ParticleFluxMoment

construction:Undocumented Class

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

Computes the flux moments $var element = document.getElementById("moose-equation-41add5a4-a89b-42a4-badc-579fe338a941");katex.render("\\Phi_{g,l,m}(\\vec{r}, t)", element, {displayMode:false,throwOnError:false});$ of the scattering source using the quadrature rule provided by the material system.

Overview

Example Input File Syntax

Input Parameters

aqThe name of the angular quadrature provider user object.
C++ Type:UserObjectName
Controllable:No
Description:The name of the angular quadrature provider user object.
degreeDegree of this angular flux moment.
C++ Type:unsigned int
Controllable:No
Description:Degree of this angular flux moment.
group_flux_ordinatesThe flux solutions for all discrete directions. Must be listed in the same order as the quadrature directions and weights.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The flux solutions for all discrete directions. Must be listed in the same order as the quadrature directions and weights.
orderOrder of this angular flux moment.
C++ Type:int
Controllable:No
Description:Order of this angular flux moment.
variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
scale_factor1A scaling factor to apply to the flux moments.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:A scaling factor to apply to the flux moments.
uncollided_flux_momentThe uncollided flux moments. Currently only supports uncollided scalar fluxes.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The uncollided flux moments. Currently only supports uncollided scalar fluxes.

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.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters

Input Files

(tests/schemes/saaf_cgfem_steady.i)

(tests/schemes/saaf_cgfem_steady.i)

[Mesh]
  [domain]
    type = CartesianMeshGenerator
    dim = 1
    dx = 10
    ix = 1000
  []
[]

[Variables]
  [angular_flux_1_1] # n = 0, Flux_Right
    order = FIRST
    family = LAGRANGE
  []
  [angular_flux_1_2] # n = 1, Flux_Left
    order = FIRST
    family = LAGRANGE
  []
[]

[AuxVariables]
  [flux_moment_1_0_0]
    order = FIRST
    family = LAGRANGE
  []
[]

[AuxKernels]
  [Flux_Moment]
    type = ParticleFluxMoment
    variable = flux_moment_1_0_0
    group_flux_ordinates = 'angular_flux_1_1 angular_flux_1_2'
    aq = AQ
    degree = 0
    order = 0
  []
[]

[Kernels]
  [Streaming_Right]
    type = SAAFStreaming
    variable = angular_flux_1_1
    aq = AQ
    ordinate_index = 0
    group_index = 0
  []
  [Streaming_Left]
    type = SAAFStreaming
    variable = angular_flux_1_2
    aq = AQ
    ordinate_index = 1
    group_index = 0
  []

  [Removal_Right]
    type = SNRemoval
    variable = angular_flux_1_1
    group_index = 0
  []
  [Removal_Left]
    type = SNRemoval
    variable = angular_flux_1_2
    group_index = 0
  []
[]

[DiracKernels]
  [Source_Right]
    type = SAAFPointSource
    variable = angular_flux_1_1
    aq = AQ
    num_groups = 1
    ordinate_index = 0
    group_index = 0
    group_source = '1000.0'
    point = '5.0 0.0 0.0'
    source_anisotropy = 0
  []
  [Source_Left]
    type = SAAFPointSource
    variable = angular_flux_1_2
    aq = AQ
    num_groups = 1
    ordinate_index = 1
    group_index = 0
    group_source = '1000.0'
    point = '5.0 0.0 0.0'
    source_anisotropy = 0
  []
[]

[BCs]
  [Right_BC]
    type = SNVacuumBC
    variable = angular_flux_1_1
    aq = AQ
    ordinate_index = 0
    boundary = 'left right'
  []
  [Left_BC]
    type = SNVacuumBC
    variable = angular_flux_1_2
    aq = AQ
    ordinate_index = 1
    boundary = 'left right'
  []
[]

[Materials]
  [Domain]
    type = AbsorbingTransportMaterial
    num_groups = 1
    group_total = 1.0
    group_speeds = 1.0
  []
[]

[UserObjects]
  [AQ]
    type = AQProvider
    dimensionality = 1D_cartesian
    aq_type = gauss_chebyshev
    n_l = 2
    n_c = 1
    major_axis = x
  []
[]

[Problem]
  type = FEProblem
[]

[Outputs]
  exodus = true
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

Overview
Example Input File Syntax
Input Parameters
Input Files