Merge pull request #1947 from pshriwise/ww-final-tests

Weight windows final push
This commit is contained in:
Paul Romano 2022-01-19 09:13:07 -06:00 committed by GitHub
commit 72af700ffd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 2244 additions and 18 deletions

View file

@ -620,9 +620,9 @@ variable and whose sub-elements/attributes are as follows:
:type:
The type of the distribution. Valid options are "uniform", "discrete",
"tabular", "maxwell", "watt", and "mixture". The "uniform" option produces
variates sampled from a uniform distribution over a finite interval. The
"discrete" option produces random variates that can assume a finite number
of values (i.e., a distribution characterized by a probability mass function).
variates sampled from a uniform distribution over a finite interval. The
"discrete" option produces random variates that can assume a finite number
of values (i.e., a distribution characterized by a probability mass function).
The "tabular" option produces random variates sampled from a tabulated
distribution where the density function is either a histogram or
linearly-interpolated between tabulated points. The "watt" option produces
@ -668,8 +668,8 @@ variable and whose sub-elements/attributes are as follows:
For a "mixture" distribution, this element provides a distribution and its corresponding probability.
:probability:
An attribute or ``pair`` that provides the probability of a univariate distribution within a "mixture" distribution.
An attribute or ``pair`` that provides the probability of a univariate distribution within a "mixture" distribution.
:dist:
This sub-element of a ``pair`` element provides information on the corresponding univariate distribution.
@ -1007,3 +1007,55 @@ sub-elements/attributes:
sample points within.
*Default*: None
----------------------------
``<weight_windows>`` Element
----------------------------
The ``<weight_windows>`` element specifies all necessary parameters for
mesh-based weight windows. This element has the following
sub-elements/attributes:
:id:
A unique integer that is used to identify the weight windows
:mesh:
ID of a mesh that is to be used for weight windows
*Default*: None
:particle_type:
The particle that the weight windows will apply to (e.g., 'neutron')
*Default*: None
:energy_bins:
Monotonically increasing list of bounding energies in [eV] to be used for
weight windows
*Default*: None
:lower_ww_bounds:
Lower weight window bound for each (energy bin, mesh bin) combination.
*Default*: None
:upper_ww_bounds:
Upper weight window bound for each (energy bin, mesh bin) combination.
*Default*: None
:survival:
The ratio of survival weight and lower weight window bound.
*Default*: 3.0
:max_split:
Maximum allowable number of particles when splitting
*Default*: 10
:weight_cutoff:
Threshold below which particles will be terminated
*Default*: :math:`10^{-38}`