- num_equal_divisionsThe number of equally spaces subdivisions of $[0, \pi]$ to use if equal subdivisions are desired.
C++ Type:unsigned int
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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.
PolarAngleFilter
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.
Input Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Set the enabled status of the MooseObject.