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

renamed dounding_box to domain, review suggestion

Browse source
This commit is contained in:
Jonathan Shimwell 2022-09-09 16:45:49 +01:00
parent 1cfbd67659
commit abc2c7cd7a
2 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

16
openmc/mesh.py
View file

@ -511,9 +511,9 @@ class RegularMesh(StructuredMesh):
return mesh
@classmethod
def from_bounding_box(
def from_domain(
cls,
bounding_box,
domain,
dimension=[100, 100, 100],
mesh_id=None,
name=''
@ -523,9 +523,9 @@ class RegularMesh(StructuredMesh):
Parameters
----------
bounding_box : {openmc.Cell, openmc.Region, openmc.Universe, openmc.Geometry}
domain : {openmc.Cell, openmc.Region, openmc.Universe, openmc.Geometry}
The object passed in will be used as a template for this mesh. The
bounding_box of the property of the object passed will be used to
domain of the property of the object passed will be used to
set the lower_left and upper_right of the mesh instance
dimension : Iterable of int
The number of mesh cells in each direction.
@ -541,14 +541,14 @@ class RegularMesh(StructuredMesh):
"""
cv.check_type(
"bounding_box",
bounding_box,
"domain",
domain,
(openmc.Cell, openmc.Region, openmc.Universe, openmc.Geometry),
)
mesh = cls(mesh_id, name)
mesh.lower_left = bounding_box.bounding_box[0]
mesh.upper_right = bounding_box.bounding_box[1]
mesh.lower_left = domain.bounding_box[0]
mesh.upper_right = domain.bounding_box[1]
mesh.dimension = dimension
return mesh

10
tests/unit_tests/test_mesh_from_bounding_box.py → tests/unit_tests/test_mesh_from_domain.py
View file

@ -9,7 +9,7 @@ def test_mesh_from_cell():
surface = openmc.Sphere(r=10, x0=2, y0=3, z0=5)
cell = openmc.Cell(region=-surface)
mesh = openmc.RegularMesh.from_bounding_box(cell, dimension=[7, 11, 13])
mesh = openmc.RegularMesh.from_domain(cell, dimension=[7, 11, 13])
assert isinstance(mesh, openmc.RegularMesh)
assert np.array_equal(mesh.dimension, (7, 11, 13))
assert np.array_equal(mesh.lower_left, cell.bounding_box[0])
@ -22,7 +22,7 @@ def test_mesh_from_region():
surface = openmc.Sphere(r=1, x0=-5, y0=-3, z0=-2)
region = -surface
mesh = openmc.RegularMesh.from_bounding_box(region)
mesh = openmc.RegularMesh.from_domain(region)
assert isinstance(mesh, openmc.RegularMesh)
assert np.array_equal(mesh.dimension, (100, 100, 100)) # default values
assert np.array_equal(mesh.lower_left, region.bounding_box[0])
@ -36,7 +36,7 @@ def test_mesh_from_universe():
cell = openmc.Cell(region=-surface)
universe = openmc.Universe(cells=[cell])
mesh = openmc.RegularMesh.from_bounding_box(universe)
mesh = openmc.RegularMesh.from_domain(universe)
assert isinstance(mesh, openmc.RegularMesh)
assert np.array_equal(mesh.dimension, (100, 100, 100)) # default values
assert np.array_equal(mesh.lower_left, universe.bounding_box[0])
@ -51,7 +51,7 @@ def test_mesh_from_geometry():
universe = openmc.Universe(cells=[cell])
geometry = openmc.Geometry(universe)
mesh = openmc.RegularMesh.from_bounding_box(geometry)
mesh = openmc.RegularMesh.from_domain(geometry)
assert isinstance(mesh, openmc.RegularMesh)
assert np.array_equal(mesh.dimension, (100, 100, 100)) # default values
assert np.array_equal(mesh.lower_left, geometry.bounding_box[0])
@ -60,4 +60,4 @@ def test_mesh_from_geometry():
def test_error_from_unsupported_object():
with pytest.raises(TypeError):
openmc.RegularMesh.from_bounding_box("vacuum energy")
openmc.RegularMesh.from_domain("vacuum energy")