Skip to content

Commit

Permalink
Re-adding units for r2
Browse files Browse the repository at this point in the history
  • Loading branch information
@pshriwise
pshriwise committed Jan 8, 2025
1 parent 11fcc46 commit 24b2692
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 25 deletions.
21 changes: 12 additions & 9 deletions openmc/model/surface_composite.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
36 changes: 20 additions & 16 deletions openmc/surface.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 24b2692

Please sign in to comment.