Update documentation for mixed thermal elastic

This commit is contained in:
Paul Romano 2022-07-21 14:37:34 -05:00
parent 4e611f59b9
commit e8294d52a0
4 changed files with 33 additions and 0 deletions

View file

@ -339,6 +339,16 @@ Incoherent elastic scattering
[eV\ :math:`^{-1}`].
:Attributes: - **type** (*char[]*) -- 'IncoherentElastic'
Sum of functions
----------------
:Object type: Group
:Attributes: - **type** (*char[]*) -- "Sum"
- **n** (*int*) -- Number of functions
:Datasets:
- ***func_<i>** (:ref:`function <1d_functions>`) -- Dataset for the
i-th function (indexing starts at 1)
.. _angle_energy:
--------------------------
@ -501,6 +511,19 @@ equiprobable bins.
- **skewed** (*int8_t*) -- Whether discrete angles are equi-probable
(0) or have a skewed distribution (1).
Mixed Elastic
-------------
This angle-energy distribution is used when an evaluation specifies both
coherent and incoherent elastic thermal neutron scattering.
:Object type: Group
:Attributes: - **type** (*char[]*) -- "mixed_elastic"
:Groups: - **coherent** -- Distribution for coherent elastic scattering. The
format is given in :ref:`angle_energy`.
- **incoherent** -- Distribution for incoherent elastic scattering.
The format is given in :ref:`angle_energy`.
.. _energy_distribution:
--------------------

View file

@ -116,6 +116,7 @@ Angle-Energy Distributions
IncoherentElasticAE
IncoherentElasticAEDiscrete
IncoherentInelasticAEDiscrete
MixedElasticAE
Resonance Data
--------------

View file

@ -581,6 +581,8 @@ class Sum(EqualityMixin):
def to_hdf5(self, group, name='xy'):
"""Write sum of functions to an HDF5 group
.. versionadded:: 0.13.1
Parameters
----------
group : h5py.Group
@ -599,6 +601,8 @@ class Sum(EqualityMixin):
def from_hdf5(cls, group):
"""Generate sum of functions from an HDF5 group
.. versionadded:: 0.13.1
Parameters
----------
group : h5py.Group

View file

@ -36,6 +36,9 @@ class CoherentElasticAE(AngleEnergy):
def to_hdf5(self, group, xs_group=None):
"""Write coherent elastic distribution to an HDF5 group
.. versionchanged:: 0.13.1
The *xs_group* argument was added.
Parameters
----------
group : h5py.Group
@ -220,6 +223,8 @@ class IncoherentInelasticAE(CorrelatedAngleEnergy):
class MixedElasticAE(AngleEnergy):
"""Secondary distribution for mixed coherent/incoherent thermal elastic
.. versionadded:: 0.13.1
Parameters
----------
coherent : AngleEnergy