Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to a consistent definition of the r2 parameter for cones #3254

Merged
merged 5 commits into from
Jan 12, 2025
Merged

Update to a consistent definition of the r2 parameter for cones #3254

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
11fcc46
Update to a consistent definition of the r2 parameter for cones
pshriwise Jan 8, 2025
24b2692
Re-adding units for r2
pshriwise Jan 8, 2025
921c2fd
Update openmc/model/surface_composite.py
pshriwise Jan 9, 2025
0285e05
Making documentation on r2 consistent again. Removing units on the r2…
pshriwise Jan 9, 2025
4f49df2
Simplify cone docstrings
paulromano Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions openmc/model/surface_composite.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
30 changes: 15 additions & 15 deletions openmc/surface.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
Loading