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

Add description of openmc.capi.Mesh attributes in docstring

Browse source
This commit is contained in:
Paul Romano 2018-04-18 07:17:02 -05:00
parent fccb26735c
commit 8886313c93
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
openmc/capi/mesh.py
View file

@ -59,6 +59,16 @@ class Mesh(_FortranObjectWithID):
----------
id : int
ID of the mesh
dimension : iterable of int
The number of mesh cells in each direction.
lower_left : numpy.ndarray
The lower-left corner of the structured mesh. If only two coordinate are
given, it is assumed that the mesh is an x-y mesh.
upper_right : numpy.ndarray
The upper-right corner of the structrued mesh. If only two coordinate
are given, it is assumed that the mesh is an x-y mesh.
width : numpy.ndarray
The width of mesh cells in each direction.
"""
__instances = WeakValueDictionary()