From 557a5c66b2ab0afd601dc71a8e0a50c9032224da Mon Sep 17 00:00:00 2001 From: Olaf Schumann Date: Tue, 5 Oct 2021 20:06:02 +0000 Subject: [PATCH] Add rational distribution to documentation --- docs/source/io_formats/settings.rst | 5 +++++ docs/source/pythonapi/stats.rst | 1 + 2 files changed, 6 insertions(+) diff --git a/docs/source/io_formats/settings.rst b/docs/source/io_formats/settings.rst index c797212c1..313d064a7 100644 --- a/docs/source/io_formats/settings.rst +++ b/docs/source/io_formats/settings.rst @@ -638,6 +638,11 @@ variable and whose sub-elements/attributes are as follows: numbers :math:`a` and :math:`b` that define the interval :math:`[a,b]` over which random variates are sampled. + For a "rational" distribution, ``parameters`` should be given as three real + numbers :math:`a` and :math:`b` that define the interval :math:`[a,b]` over + which random variates are sampled and :math:`n` that defines the exponent of + the probability distribution :math:`p(x)=x^n` + For a "discrete" or "tabular" distribution, ``parameters`` provides the :math:`(x,p)` pairs defining the discrete/tabular distribution. All :math:`x` points are given first followed by corresponding :math:`p` points. diff --git a/docs/source/pythonapi/stats.rst b/docs/source/pythonapi/stats.rst index d14aff558..55f18f45d 100644 --- a/docs/source/pythonapi/stats.rst +++ b/docs/source/pythonapi/stats.rst @@ -15,6 +15,7 @@ Univariate Probability Distributions openmc.stats.Univariate openmc.stats.Discrete openmc.stats.Uniform + openmc.stats.Rational openmc.stats.Maxwell openmc.stats.Watt openmc.stats.Tabular