openmc.stats.CylindricalIndependent

class openmc.stats.CylindricalIndependent(r, phi, z, origin=(0.0, 0.0, 0.0), r_dir=(1.0, 0.0, 0.0), z_dir=(0.0, 0.0, 1.0))[source]

Spatial distribution represented in cylindrical coordinates.

This distribution allows one to specify coordinates whose \(r\), \(\phi\), and \(z\) components are sampled independently from one another and in a reference frame whose origin is specified by the coordinates (x0, y0, z0).

Added in version 0.12.

Parameters:

  • r (openmc.stats.Univariate) – Distribution of r-coordinates in a reference frame specified by the origin parameter

  • phi (openmc.stats.Univariate) – Distribution of phi-coordinates (azimuthal angle) in a reference frame specified by the origin parameter

  • z (openmc.stats.Univariate) – Distribution of z-coordinates in a reference frame specified by the origin parameter

  • origin (Iterable of float, optional) – coordinates (x0, y0, z0) of the center of the cylindrical reference frame. Defaults to (0.0, 0.0, 0.0)

  • r_dir (Iterable of float, optional) – Unit vector of the cylinder r axis at phi=0.

  • z_dir (Iterable of float, optional) – Unit vector of the cylinder z axis direction.

Variables:

  • r (openmc.stats.Univariate) – Distribution of r-coordinates in the local reference frame

  • phi (openmc.stats.Univariate) – Distribution of phi-coordinates (azimuthal angle) in the local reference frame

  • z (openmc.stats.Univariate) – Distribution of z-coordinates in the local reference frame

  • origin (Iterable of float, optional) – coordinates (x0, y0, z0) of the center of the cylindrical reference frame. Defaults to (0.0, 0.0, 0.0)

  • r_dir (Iterable of float, optional) – Unit vector of the cylinder r axis at phi=0.

  • z_dir (Iterable of float, optional) – Unit vector of the cylinder z axis direction.

classmethod from_xml_element(elem: Element)[source]

Generate spatial distribution from an XML element

Parameters:

elem (lxml.etree._Element) – XML element

Returns:

Spatial distribution generated from XML element

Return type:

openmc.stats.CylindricalIndependent

to_xml_element()[source]

Return XML representation of the spatial distribution

Returns:

element – XML element containing spatial distribution data

Return type:

lxml.etree._Element