openmc.model.hexagonal_prism

openmc.model.hexagonal_prism(edge_length=1.0, orientation='y', origin=(0.0, 0.0), boundary_type='transmission', corner_radius=0.0)[source]

Create a hexagon region from six surface planes.

Changed in version 0.11: This function was renamed from get_hexagonal_prism to hexagonal_prism.

Parameters:
  • edge_length (float) – Length of a side of the hexagon in cm
  • orientation ({'x', 'y'}) – An ‘x’ orientation means that two sides of the hexagon are parallel to the x-axis and a ‘y’ orientation means that two sides of the hexagon are parallel to the y-axis.
  • origin (Iterable of two floats) – Origin of the prism. Defaults to (0., 0.).
  • boundary_type ({'transmission, 'vacuum', 'reflective', 'periodic'}) – Boundary condition that defines the behavior for particles hitting the surfaces comprising the hexagonal prism (default is ‘transmission’).
  • corner_radius (float) – Prism corner radius in units of cm. Defaults to 0.
Returns:

The inside of a hexagonal prism

Return type:

openmc.Region