crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-26 21:25:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

added return type to bin width method

Browse source
This commit is contained in:
Jonathan Shimwell 2022-08-08 13:52:50 +01:00
parent 75548aade8
commit bb764b960a
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
openmc/filter.py
View file

@ -1325,8 +1325,14 @@ class EnergyFilter(RealFilter):
cv.check_greater_than('filter value', v1, 0., equality=True)
def bin_log_width(self):
"""Returns the base 10 log width of energy bins which is useful when
plotting the normalized flux"""
"""Calculates the base 10 log width of energy bins which is useful when
plotting the normalized flux.
Returns
-------
numpy.array
Array of bin widths
"""
bin_edges = np.unique(self.bins)
log_width = np.log10(bin_edges[1:]/bin_edges[:-1])
return log_width