openmc.Plane¶
-
class
openmc.
Plane
(surface_id=None, boundary_type='transmission', A=1.0, B=0.0, C=0.0, D=0.0, name='')[source]¶ An arbitrary plane of the form \(Ax + By + Cz = D\).
Parameters: - surface_id (int, optional) – Unique identifier for the surface. If not specified, an identifier will automatically be assigned.
- boundary_type ({'transmission, 'vacuum', 'reflective'}, optional) – Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles freely pass through the surface.
- A (float, optional) – The ‘A’ parameter for the plane. Defaults to 1.
- B (float, optional) – The ‘B’ parameter for the plane. Defaults to 0.
- C (float, optional) – The ‘C’ parameter for the plane. Defaults to 0.
- D (float, optional) – The ‘D’ parameter for the plane. Defaults to 0.
- name (str, optional) – Name of the plane. If not specified, the name will be the empty string.
Variables: - a (float) – The ‘A’ parameter for the plane
- b (float) – The ‘B’ parameter for the plane
- c (float) – The ‘C’ parameter for the plane
- d (float) – The ‘D’ parameter for the plane
- boundary_type ({'transmission, 'vacuum', 'reflective'}) – 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
-
to_xml_element
()[source]¶ Return XML representation of the surface
Returns: element – XML element containing source data Return type: xml.etree.ElementTree.Element