PolarAngleFilter

commentnote

PolarAngleFilter 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 PolarAngleFilter object provides a thin wrapper around an OpenMC PolarFilter which local tallies (added through the tally system) can access. Two bin options are available; equally spaced bins (setting num_equal_divisions) or custom bins (setting polar_angle_boundaries).

Example Input File Syntax

As an example, a MeshTally named Flux applies an PolarAngleFilter named Polar to break the total flux up into two hemispheres.

[Problem]
  type = OpenMCCellAverageProblem
  verbose = true
  power = 1e4
  temperature_blocks = '100'
  cell_level = 0
  initial_properties = xml

  source_rate_normalization = 'kappa_fission'

  # Disable global normalization since we have a loosely fitting mesh tally.
  normalize_by_global_tally = false

  [Tallies]
    [Heating]
      type = CellTally
      score = 'kappa_fission'
      blocks = '100'
    []
    [Flux]
      type = MeshTally
      score = 'flux'
      mesh_template = ../../meshes/sphere.e
      mesh_translations = '0 0 0
                           0 0 4
                           0 0 8'
      filters = 'Polar'
    []
  []

  [Filters]
    [Polar]
      type = PolarAngleFilter
      num_equal_divisions = 2
    []
  []
[]
(test/tests/neutronics/filters/polar/mesh.i)

Input Parameters

  • num_equal_divisionsThe number of equally spaces subdivisions of $[0, \pi]$ to use if equal subdivisions are desired.

    C++ Type:unsigned int

    Controllable:No

    Description:The number of equally spaces subdivisions of $[0, \pi]$ to use if equal subdivisions are desired.

  • polar_angle_boundariesThe polar angle boundaries in $[0, \pi]$ which must be provided in increasing order. If 0 and $\pi$ are not included this filter may result in some missed particles during normalization.

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

    Controllable:No

    Description:The polar angle boundaries in $[0, \pi]$ which must be provided in increasing order. If 0 and $\pi$ are not included this filter may result in some missed particles during normalization.

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

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files