openmc.XPlane

class openmc.XPlane(x0=0.0, *args, **kwargs)[source]

A plane perpendicular to the x axis of the form \(x - x_0 = 0\)

Parameters:
  • x0 (float, optional) – Location of the plane. Defaults to 0.
  • boundary_type ({'transmission, 'vacuum', 'reflective', 'periodic', 'white'}, optional) – Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles freely pass through the surface. Only axis-aligned periodicity is supported, i.e., x-planes can only be paired with x-planes.
  • name (str, optional) – Name of the plane. If not specified, the name will be the empty string.
  • surface_id (int, optional) – Unique identifier for the surface. If not specified, an identifier will automatically be assigned.
Variables:
  • x0 (float) – Location of the plane
  • boundary_type ({'transmission, 'vacuum', 'reflective', 'periodic', 'white'}) – Boundary condition that defines the behavior for particles hitting the surface.
  • periodic_surface (openmc.Surface) – If a periodic boundary condition is used, the surface with which this one is periodic with
  • coefficients (dict) – Dictionary of surface coefficients
  • id (int) – Unique identifier for the surface
  • name (str) – Name of the surface
  • type (str) – Type of the surface
evaluate(point)[source]

Evaluate the surface equation at a given point.

Parameters:point (3-tuple of float) – The Cartesian coordinates, \((x',y',z')\), at which the surface equation should be evaluated.
Returns:\(Ax' + By' + Cz' - D\)
Return type:float