From 24b2692a21fd9626a625b035779ff14dbfc7cf13 Mon Sep 17 00:00:00 2001 From: Patrick Shriwise Date: Wed, 8 Jan 2025 14:39:53 -0600 Subject: [PATCH] Re-adding units for r2 --- openmc/model/surface_composite.py | 21 ++++++++++-------- openmc/surface.py | 36 +++++++++++++++++-------------- 2 files changed, 32 insertions(+), 25 deletions(-) diff --git a/openmc/model/surface_composite.py b/openmc/model/surface_composite.py index 4a2d1771ccc..b76cd568dfe 100644 --- a/openmc/model/surface_composite.py +++ b/openmc/model/surface_composite.py @@ -748,9 +748,10 @@ class XConeOneSided(CompositeSurface): z0 : float, optional z-coordinate of the apex. Defaults to 0. r2 : float, optional - 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. + Parameter related to the aperture [:math:`\\rm cm^2`]. 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 +803,10 @@ class YConeOneSided(CompositeSurface): z0 : float, optional z-coordinate of the apex. Defaults to 0. r2 : float, optional - 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. + Parameter related to the aperture [:math:`\\rm cm^2`]. 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 +857,10 @@ class ZConeOneSided(CompositeSurface): z0 : float, optional z-coordinate of the apex. Defaults to 0. r2 : float, optional - 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. + Parameter related to the aperture [:math:`\\rm cm^2`]. 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 81a39111e09..31634b16ee5 100644 --- a/openmc/surface.py +++ b/openmc/surface.py @@ -1769,9 +1769,10 @@ 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. 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. + Parameter related to the aperture [:math:`\\rm cm^2`]. 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 +1806,7 @@ class Cone(QuadricMixin, Surface): z0 : float z-coordinate of the apex in [cm] r2 : float - Parameter related to the aperture + Parameter related to the aperture [:math:`\\rm cm^2`] dx : float x-component of the vector representing the axis of the cone. dy : float @@ -1927,9 +1928,10 @@ 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. 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. + Parameter related to the aperture [:math:`\\rm cm^2`]. This is t1he + 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 @@ -1953,7 +1955,7 @@ class XCone(QuadricMixin, Surface): z0 : float z-coordinate of the apex in [cm] r2 : float - Parameter related to the aperature + Parameter related to the aperture [:math:`\\rm cm^2`] boundary_type : {'transmission', 'vacuum', 'reflective', 'white'} Boundary condition that defines the behavior for particles hitting the surface. @@ -2028,9 +2030,10 @@ 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. 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. + Parameter related to the aperture [:math:`\\rm cm^2`]. 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 +2057,7 @@ class YCone(QuadricMixin, Surface): z0 : float z-coordinate of the apex in [cm] r2 : float - Parameter related to the aperture. + Parameter related to the aperture [:math:`\\rm cm^2`]. boundary_type : {'transmission', 'vacuum', 'reflective', 'white'} Boundary condition that defines the behavior for particles hitting the surface. @@ -2129,9 +2132,10 @@ class ZCone(QuadricMixin, Surface): z0 : float, optional z-coordinate of the apex in [cm]. Defaults to 0. r2 : float, optional - 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. + Parameter related to the aperture [:math:`\\rm cm^2`]. 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 +2159,7 @@ class ZCone(QuadricMixin, Surface): z0 : float z-coordinate of the apex in [cm] r2 : float - Parameter related to the aperture. + Parameter related to the aperture [:math:`\\rm cm^2`]. boundary_type : {'transmission', 'vacuum', 'reflective', 'white'} Boundary condition that defines the behavior for particles hitting the surface.