Improving documentation on the return array of openmc.lib.id_map (#2630)

This commit is contained in:
Patrick Shriwise 2023-08-05 15:54:09 -05:00 committed by GitHub
parent 557880aefc
commit f9c17dd82f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -229,7 +229,8 @@ def id_map(plot):
-------
id_map : numpy.ndarray
A NumPy array with shape (vertical pixels, horizontal pixels, 3) of
OpenMC property ids with dtype int32
OpenMC property ids with dtype int32. The last dimension of the array
contains, in order, cell IDs, cell instances, and material IDs.
"""
img_data = np.zeros((plot.v_res, plot.h_res, 3),