crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 06:05:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update diff tally docs

Browse source
This commit is contained in:
Sterling Harper 2016-02-01 12:46:21 -05:00
parent 7764b842a0
commit 017a8735c3
8 changed files with 134 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

50
docs/source/usersguide/input.rst
View file

@ -1708,25 +1708,11 @@ The ``<tally>`` element accepts the following sub-elements:
*Default*: "all"
:derivative:
Tally the first-order derivative of the quantity of interest with respect to
some material perturbation. Differential tallies are currently only
implemented for collision and analog estimators.
The id of a ``derivative`` element. This derivative will be applied to all
scores in the tally. Differential tallies are currently only implemented
for collision and analog estimators.
The ``derivative`` element has the following attributes/sub-elements:
:variable:
The independent variable of the derivative. Accepted options are
"density" and "nuclide_density". A "density" derivative will give the
derivative with respect to the density of the material in [g / cm^3]. A
"nuclide_density" derivative will give the derivative with respect to
the density of a particular nuclide in units of [atom / b / cm].
:material:
The perturbed material. (Necessary for both "density" and
"nuclide_density")
:nuclide:
The perturbed nuclide. (Necessary only for "nuclide_density")
*Default*: None
``<mesh>`` Element
------------------
@ -1756,6 +1742,34 @@ attributes/sub-elements:
One of ``<upper_right>`` or ``<width>`` must be specified, but not both
(even if they are consistent with one another).
``<derivative>`` Element
------------------------
OpenMC can take the first-order derivative of many tallies with respect to
material perturbations. It works by propagating a derivative through the
transport equation. Essentially, OpenMC keeps track of how each particle's
weight would change as materials are perturbed, and then accounts for that
weight change in the tallies. Note that this assumes material perturbations are
small enough not to change the distribution of fission sites. This element has
the following attributes/sub-elements:
:id:
A unique integer that can be used to identify the derivative.
:variable:
The independent variable of the derivative. Accepted options are
"density" and "nuclide_density". A "density" derivative will give the
derivative with respect to the density of the material in [g / cm^3]. A
"nuclide_density" derivative will give the derivative with respect to
the density of a particular nuclide in units of [atom / b / cm].
:material:
The perturbed material. (Necessary for both "density" and
"nuclide_density")
:nuclide:
The perturbed nuclide. (Necessary only for "nuclide_density")
``<assume_separate>`` Element
-----------------------------

16
docs/source/usersguide/output/statepoint.rst
View file

@ -156,6 +156,18 @@ if run_mode == 'k-eigenvalue':
Width of each mesh cell in each dimension.
**/tallies/derivatives/derivative <id>/independent variable** (*char[]*)
Independent variable of tally derivative
**/tallies/derivatives/derivative <id>/material** (*int*)
ID of the perturbed material
**/tallies/derivatives/derivative <id>/nuclide** (*char[]*)
Alias of the perturbed nuclide
**/tallies/n_tallies** (*int*)
Number of user-defined tallies.
@ -198,6 +210,10 @@ if run_mode == 'k-eigenvalue':
Array of nuclides to tally. Note that if no nuclide is specified in the user
input, a single 'total' nuclide appears here.
**/tallies/tally <uid>/derivative** (*int*)
ID of the derivative applied to the tally.
**/tallies/tally <uid>/n_score_bins** (*int*)
Number of scoring bins for a single nuclide. In general, this can be greater