AngularLegendreFilter

commentnote

AngularLegendreFilter can only be added to problems when the input file contains a OpenMCCellAverageProblem in the [Problem] block. Otherwise, attempting to add this filter will result in an error.

Description

The AngularLegendreFilter object provides a thin wrapper around an OpenMC LegendreFilter which local tallies (added through the tally system) can access. This filter expands the change in particle direction in Legendre polynomials of an arbitrary order.

Example Input File Syntax

As an example, a CellTally named Scattering applies an AngularLegendreFilter named Legendre to compute a Legendre expansion of the scattering reaction rate with order 1.

[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
  type = OpenMCCellAverageProblem
  verbose = true
  power = 1e4
  temperature_blocks = '100'
  cell_level = 0
  initial_properties = xml

  source_rate_normalization = 'kappa_fission'

  [Tallies<<<{"href": "../../syntax/Problem/Tallies/index.html"}>>>]
    [Heating]
      type = CellTally<<<{"description": "A class which implements distributed cell tallies.", "href": "../tallies/CellTally.html"}>>>
      score<<<{"description": "Score(s) to use in the OpenMC tallies. If not specified, defaults to 'kappa_fission'"}>>> = 'kappa_fission'
      block<<<{"description": "Subdomains for which to add tallies in OpenMC. If not provided, cell tallies will be applied over the entire mesh."}>>> = '100 200'
    []
    [Scattering]
      type = CellTally<<<{"description": "A class which implements distributed cell tallies.", "href": "../tallies/CellTally.html"}>>>
      score<<<{"description": "Score(s) to use in the OpenMC tallies. If not specified, defaults to 'kappa_fission'"}>>> = 'scatter'
      block<<<{"description": "Subdomains for which to add tallies in OpenMC. If not provided, cell tallies will be applied over the entire mesh."}>>> = '100 200'
      filters<<<{"description": "External filters to add to this tally."}>>> = 'Legendre'
      estimator<<<{"description": "Type of tally estimator to use in OpenMC"}>>> = 'analog'
    []
  []

  [Filters<<<{"href": "../../syntax/Problem/Filters/index.html"}>>>]
    [Legendre]
      type = AngularLegendreFilter<<<{"description": "A class which provides a thin wrapper around an OpenMC LegendreFilter.", "href": "AngularLegendreFilter.html"}>>>
      order<<<{"description": "The order of the Legendre expansion."}>>> = 1
    []
  []
[]
(cardinal/test/tests/neutronics/filters/legendre/cell.i)

Input Parameters

  • orderThe order of the Legendre expansion.

    C++ Type:unsigned int

    Controllable:No

    Description:The order of the Legendre expansion.

Required 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:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters