From 11fcc462abe925f078c89259bcda9d3c2034be64 Mon Sep 17 00:00:00 2001 From: Patrick Shriwise Date: Wed, 8 Jan 2025 13:35:02 -0600 Subject: [PATCH] Update to a consistent definition of the r2 parameter for cones --- openmc/model/surface_composite.py | 18 +++++++++--------- openmc/surface.py | 30 +++++++++++++++--------------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/openmc/model/surface_composite.py b/openmc/model/surface_composite.py index 1f25b9ca636..4a2d1771ccc 100644 --- a/openmc/model/surface_composite.py +++ b/openmc/model/surface_composite.py @@ -748,9 +748,9 @@ class XConeOneSided(CompositeSurface): z0 : float, optional z-coordinate of the apex. Defaults to 0. r2 : float, optional - Parameter related to the aperture [:math:`\\rm cm^2`]. - It can be interpreted as the increase in the radius squared per cm along - the cone's axis of revolution. + Parameter related to the aperture. This is the square of the radius of + the cone 1 cm from the apex. This can also be treated as the square of + the cone's slope relative to its axis of revolution. Defaults to 1. up : bool Whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of @@ -802,9 +802,9 @@ class YConeOneSided(CompositeSurface): z0 : float, optional z-coordinate of the apex. Defaults to 0. r2 : float, optional - Parameter related to the aperture [:math:`\\rm cm^2`]. - It can be interpreted as the increase in the radius squared per cm along - the cone's axis of revolution. + Parameter related to the aperture. This is the square of the radius of + the cone 1 cm from the apex. This can also be treated as the square of + the cone's slope relative to its axis of revolution. Defaults to 1. up : bool Whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of @@ -855,9 +855,9 @@ class ZConeOneSided(CompositeSurface): z0 : float, optional z-coordinate of the apex. Defaults to 0. r2 : float, optional - Parameter related to the aperture [:math:`\\rm cm^2`]. - It can be interpreted as the increase in the radius squared per cm along - the cone's axis of revolution. + Parameter related to the aperture. This is the square of the radius of + the cone 1 cm from the apex. This can also be treated as the square of + the cone's slope relative to its axis of revolution. Defaults to 1. up : bool Whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of diff --git a/openmc/surface.py b/openmc/surface.py index c95025f949b..81a39111e09 100644 --- a/openmc/surface.py +++ b/openmc/surface.py @@ -1769,9 +1769,9 @@ class Cone(QuadricMixin, Surface): z0 : float, optional z-coordinate of the apex in [cm]. Defaults to 0. r2 : float, optional - Parameter related to the aperture [:math:`\\rm cm^2`]. - It can be interpreted as the increase in the radius squared per cm along - the cone's axis of revolution. + Parameter related to the aperture. This is the square of the radius of + the cone 1 cm from the apex. This can also be treated as the square of + the cone's slope relative to its axis of revolution. Defaults to 1. dx : float, optional x-component of the vector representing the axis of the cone. Defaults to 0. @@ -1805,7 +1805,7 @@ class Cone(QuadricMixin, Surface): z0 : float z-coordinate of the apex in [cm] r2 : float - Parameter related to the aperature [cm^2] + Parameter related to the aperture dx : float x-component of the vector representing the axis of the cone. dy : float @@ -1927,9 +1927,9 @@ class XCone(QuadricMixin, Surface): z0 : float, optional z-coordinate of the apex in [cm]. Defaults to 0. r2 : float, optional - Parameter related to the aperture [:math:`\\rm cm^2`]. - It can be interpreted as the increase in the radius squared per cm along - the cone's axis of revolution. + Parameter related to the aperture. This is the square of the radius of + the cone 1 cm from the apex. This can also be treated as the square of + the cone's slope relative to its axis of revolution. Defaults to 1. 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 @@ -2028,9 +2028,9 @@ class YCone(QuadricMixin, Surface): z0 : float, optional z-coordinate of the apex in [cm]. Defaults to 0. r2 : float, optional - Parameter related to the aperture [:math:`\\rm cm^2`]. - It can be interpreted as the increase in the radius squared per cm along - the cone's axis of revolution. + Parameter related to the aperture. This is the square of the radius of + the cone 1 cm from the apex. This can also be treated as the square of + the cone's slope relative to its axis of revolution. Defaults to 1. 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 @@ -2054,7 +2054,7 @@ class YCone(QuadricMixin, Surface): z0 : float z-coordinate of the apex in [cm] r2 : float - Parameter related to the aperature + Parameter related to the aperture. boundary_type : {'transmission', 'vacuum', 'reflective', 'white'} Boundary condition that defines the behavior for particles hitting the surface. @@ -2129,9 +2129,9 @@ class ZCone(QuadricMixin, Surface): z0 : float, optional z-coordinate of the apex in [cm]. Defaults to 0. r2 : float, optional - Parameter related to the aperature [cm^2]. - This is the square of the radius of the cone 1 cm from. - This can also be treated as the square of the slope of the cone relative to its axis. + Parameter related to the aperture. This is the square of the radius of + the cone 1 cm from the apex. This can also be treated as the square of + the cone's slope relative to its axis of revolution. Defaults to 1. 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 @@ -2155,7 +2155,7 @@ class ZCone(QuadricMixin, Surface): z0 : float z-coordinate of the apex in [cm] r2 : float - Parameter related to the aperature + Parameter related to the aperture. boundary_type : {'transmission', 'vacuum', 'reflective', 'white'} Boundary condition that defines the behavior for particles hitting the surface.