openmc.CylindricalMesh¶

class openmc.CylindricalMesh(r_grid: Sequence[float], z_grid: Sequence[float], phi_grid: Sequence[float] = (0, 6.283185307179586), origin: Sequence[float] = (0.0, 0.0, 0.0), mesh_id: Optional[int] = None, name: str = '')[source]¶

A 3D cylindrical mesh

Parameters

r_grid (numpy.ndarray) – 1-D array of mesh boundary points along the r-axis Requirement is r >= 0.
z_grid (numpy.ndarray) – 1-D array of mesh boundary points along the z-axis relative to the origin.
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.
origin (numpy.ndarray) – 1-D array of length 3 the (x,y,z) origin of the mesh in cartesian coordinates
mesh_id (int) – Unique identifier for the mesh
name (str) – Name of the mesh

Variables

id (int) – Unique identifier for the mesh
name (str) – Name of the mesh
dimension (Iterable of int) – The number of mesh cells in each direction (r_grid, phi_grid, z_grid).
n_dimension (int) – Number of mesh dimensions (always 3 for a CylindricalMesh).
r_grid (numpy.ndarray) – 1-D array of mesh boundary points along the r-axis. Requirement is r >= 0.
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.
z_grid (numpy.ndarray) – 1-D array of mesh boundary points along the z-axis relative to the origin.
origin (numpy.ndarray) – 1-D array of length 3 the (x,y,z) origin of the mesh in cartesian coordinates
indices (Iterable of tuple) – An iterable of mesh indices for each mesh element, e.g. [(1, 1, 1), (2, 1, 1), …]
lower_left (Iterable of float) – 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 (Iterable of float) – The upper-right corner of the structured mesh. If only two coordinate are given, it is assumed that the mesh is an x-y mesh.
bounding_box (openmc.BoundingBox) – Axis-aligned bounding box of the mesh as defined by the upper-right and lower-left coordinates.

property centroids¶

Return coordinates of mesh element centroids.

Returns: centroids – Returns a numpy.ndarray representing the mesh element centroid coordinates with a shape equal to (dim1, …, dimn, ndim). X, Y, Z values can be unpacked with xx, yy, zz = np.rollaxis(mesh.centroids, -1).
Return type: numpy.ndarray

property centroids_cylindrical¶: Returns centroids of the mesh in cylindrical coordinates.

classmethod from_domain(domain: Union[Cell, Region, Universe, Geometry], dimension: Sequence[int] = (10, 10, 10), mesh_id: Optional[int] = None, phi_grid_bounds: Sequence[float] = (0.0, 6.283185307179586), name: str = '')[source]¶

Creates a regular CylindricalMesh from an existing openmc domain.

Parameters

domain (openmc.Cell or openmc.Region or openmc.Universe or 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 set the r_grid, z_grid ranges.
dimension (Iterable of int) – The number of equally spaced mesh cells in each direction (r_grid, phi_grid, z_grid)
mesh_id (int) – Unique identifier for the mesh
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

Returns

CylindricalMesh instance

Return type

openmc.CylindricalMesh

classmethod from_hdf5(group: Group)[source]¶

Create mesh from HDF5 group

classmethod from_xml_element(elem: Element)[source]¶

Generate a cylindrical mesh from an XML element

get_indices_at_coords(coords: Sequence[float]) → Tuple[int, int, int][source]¶

Finds the index of the mesh voxel at the specified x,y,z coordinates.

New in version 0.15.0.

to_xml_element()[source]¶

Return XML representation of the mesh

property vertices¶

Return coordinates of mesh vertices in Cartesian coordinates. Also: see CylindricalMesh.vertices_cylindrical() and SphericalMesh.vertices_spherical() for coordinates in other coordinate systems.

Returns: vertices – Returns a numpy.ndarray representing the coordinates of the mesh vertices with a shape equal to (dim1 + 1, …, dimn + 1, ndim). X, Y, Z values can be unpacked with xx, yy, zz = np.rollaxis(mesh.vertices, -1).
Return type: numpy.ndarray

property vertices_cylindrical¶: Returns vertices of the mesh in cylindrical coordinates.

property volumes¶

Return Volumes for every mesh cell