openmc.model.rectangular_prism¶
-
openmc.model.rectangular_prism(width, height, axis='z', origin=(0.0, 0.0), boundary_type='transmission', corner_radius=0.0)[source]¶ Get an infinite rectangular prism from four planar surfaces.
Changed in version 0.11: This function was renamed from get_rectangular_prism to rectangular_prism.
Parameters: - width (float) – Prism width in units of cm. The width is aligned with the y, x, or x axes for prisms parallel to the x, y, or z axis, respectively.
- height (float) – Prism height in units of cm. The height is aligned with the z, z, or y axes for prisms parallel to the x, y, or z axis, respectively.
- axis ({'x', 'y', 'z'}) – Axis with which the infinite length of the prism should be aligned. Defaults to ‘z’.
- origin (Iterable of two floats) – Origin of the prism. The two floats correspond to (y,z), (x,z) or (x,y) for prisms parallel to the x, y or z axis, respectively. Defaults to (0., 0.).
- boundary_type ({'transmission, 'vacuum', 'reflective', 'periodic'}) – Boundary condition that defines the behavior for particles hitting the surfaces comprising the rectangular prism (default is ‘transmission’).
- corner_radius (float) – Prism corner radius in units of cm. Defaults to 0.
Returns: The inside of a rectangular prism
Return type: