openmc.Cone¶

class openmc.Cone(x0=0.0, y0=0.0, z0=0.0, r2=1.0, dx=0.0, dy=0.0, dz=1.0, *args, **kwargs)[source]¶

A conical surface parallel to the x-, y-, or z-axis.

Note

This creates a double cone, which is two one-sided cones that meet at their apex. For a one-sided cone see XConeOneSided, YConeOneSided, and ZConeOneSided.

Parameters

x0 (float, optional) – x-coordinate of the apex in [cm].
y0 (float, optional) – y-coordinate of the apex in [cm].
z0 (float, optional) – z-coordinate of the apex in [cm].
r2 (float, optional) – The square of the slope of the cone. It is defined as \(\left(\frac{r}{h}\right)^2\) for a radius, \(r\) and an axial distance \(h\) from the apex. An easy way to define this quantity is to take the square of the radius of the cone (in cm) 1 cm from the apex.
dx (float, optional) – x-component of the vector representing the axis of the cone.
dy (float, optional) – y-component of the vector representing the axis of the cone.
dz (float, optional) – z-component of the vector representing the axis of the cone.
surface_id (int, optional) – Unique identifier for the surface. If not specified, an identifier will automatically be assigned.
boundary_type ({'transmission', 'vacuum', 'reflective', '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.
albedo (float, optional) – Albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. Values must be positive. Only applicable if the boundary type is ‘reflective’, ‘periodic’, or ‘white’.
name (str) – Name of the cone. If not specified, the name will be the empty string.

Variables

x0 (float) – x-coordinate of the apex in [cm]
y0 (float) – y-coordinate of the apex in [cm]
z0 (float) – z-coordinate of the apex in [cm]
r2 (float) – Parameter related to the aperture
dx (float) – x-component of the vector representing the axis of the cone.
dy (float) – y-component of the vector representing the axis of the cone.
dz (float) – z-component of the vector representing the axis of the cone.
boundary_type ({'transmission', 'vacuum', 'reflective', 'white'}) – Boundary condition that defines the behavior for particles hitting the surface.
albedo (float) – Boundary albedo as a positive multiplier of particle weight
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

to_xml_element()[source]¶

Return XML representation of the surface