doc string related review suggestions

This commit is contained in:
Jonathan Shimwell 2022-10-05 09:03:30 +01:00
parent afbd994d4f
commit 9a61aed2ef

View file

@ -514,7 +514,7 @@ class RegularMesh(StructuredMesh):
def from_domain(
cls,
domain,
dimension=[100, 100, 100],
dimension=(10, 10, 10),
mesh_id=None,
name=''
):
@ -1141,14 +1141,12 @@ class CylindricalMesh(StructuredMesh):
def from_domain(
cls,
domain,
dimension=(100, 100, 100),
dimension=(10, 10, 10),
mesh_id=None,
phi_grid=(0.0, 2*pi),
phi_grid_bounds=(0.0, 2*pi),
name=''
):
"""Create mesh from an existing openmc cell, region, universe or
geometry by making use of the objects bounding box property. phi_grid
is set to have a range of 0 to 2π by default.
"""Creates a regular CylindricalMesh from an existing openmc domain.
Parameters
----------
@ -1161,9 +1159,9 @@ class CylindricalMesh(StructuredMesh):
phi_grid, z_grid)
mesh_id : int
Unique identifier for the mesh
phi_grid : numpy.ndarray
1-D array of mesh boundary points along the phi-axis in radians.
The default value is (0, 2π), i.e., the full phi range.
phi_grid_bounds : numpy.ndarray
Mesh bounds points along the phi-axis in radians. The default value
is (0, 2π), i.e., the full phi range.
name : str
Name of the mesh
@ -1191,8 +1189,16 @@ class CylindricalMesh(StructuredMesh):
cached_bb[1][1],
]
)
mesh.r_grid = np.linspace(0, max_bounding_box_radius, num=dimension[0]+1)
mesh.phi_grid = np.linspace(phi_grid[0], phi_grid[1], num=dimension[1]+1)
mesh.r_grid = np.linspace(
0,
max_bounding_box_radius,
num=dimension[0]+1
)
mesh.phi_grid = np.linspace(
phi_grid_bounds[0],
phi_grid_bounds[1],
num=dimension[1]+1
)
mesh.z_grid = np.linspace(
cached_bb[0][2],
cached_bb[1][2],