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

Clarifying documentation for Cones #2892

Merged
merged 8 commits into from
Mar 9, 2024
Merged

Clarifying documentation for Cones #2892

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
36e2c09
Clarified how r2 parameter for Cones work.
MicahGale Mar 4, 2024
fce461c
Added notes pointing to onesided cones from cone.
MicahGale Mar 4, 2024
b9448fb
Updated note on cone to be cleaner.
MicahGale Mar 6, 2024
ad01f48
Updated phrasing for r_squared.
MicahGale Mar 6, 2024
cf0b08d
Correct class names in links.
MicahGale Mar 6, 2024
7cf1694
Fixed typo in docs.
MicahGale Mar 6, 2024
4367bca
Clarified r2 for ConeOneSided
MicahGale Mar 6, 2024
faddfb1
Disambiguation about the disambiguation surface.
MicahGale Mar 7, 2024
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
35 changes: 30 additions & 5 deletions openmc/surface.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1748,6 +1748,11 @@ def evaluate(self, point):
class Cone(QuadricMixin, Surface):
"""A conical surface parallel to the x-, y-, or z-axis.

.. Note::
This creates a double cone, which is two "traditional" cones that meet at their apex.
For a "traditional" cone see :class:`~openmc.model.XConeSided`,
:class:`~openmc.model.YConeSided`, and :class:`~openmc.model.ZConeSided`.

Parameters
----------
x0 : float, optional
Expand All @@ -1757,7 +1762,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 aperature. Defaults to 1.
Parameter related to the aperature [cm^2]
This is the square of the radius of the cone 1 cm from.
MicahGale marked this conversation as resolved.
Show resolved Hide resolved
This can also be treated as the square of the slope of the cone relative to its axis.
dx : float, optional
x-component of the vector representing the axis of the cone.
Defaults to 0.
Expand Down Expand Up @@ -1791,7 +1798,7 @@ class Cone(QuadricMixin, Surface):
z0 : float
z-coordinate of the apex in [cm]
r2 : float
Parameter related to the aperature
Parameter related to the aperature [cm^2]
dx : float
x-component of the vector representing the axis of the cone.
dy : float
Expand Down Expand Up @@ -1900,6 +1907,10 @@ class XCone(QuadricMixin, Surface):
"""A cone parallel to the x-axis of the form :math:`(y - y_0)^2 + (z - z_0)^2 =
r^2 (x - x_0)^2`.

.. Note::
This creates a double cone, which is two "traditional" cones that meet at their apex.
For a "traditional" cone see :class:`~openmc.model.XConeSided`.
MicahGale marked this conversation as resolved.
Show resolved Hide resolved

Parameters
----------
x0 : float, optional
Expand All @@ -1909,7 +1920,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 aperature. Defaults to 1.
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.
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 @@ -1995,6 +2008,10 @@ class YCone(QuadricMixin, Surface):
"""A cone parallel to the y-axis of the form :math:`(x - x_0)^2 + (z - z_0)^2 =
r^2 (y - y_0)^2`.

.. Note::
This creates a double cone, which is two "traditional" cones that meet at their apex.
For a "traditional" cone see :class:`~openmc.model.YConeSided`.
MicahGale marked this conversation as resolved.
Show resolved Hide resolved

Parameters
----------
x0 : float, optional
Expand All @@ -2004,7 +2021,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 aperature. Defaults to 1.
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.
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 @@ -2090,6 +2109,10 @@ class ZCone(QuadricMixin, Surface):
"""A cone parallel to the z-axis of the form :math:`(x - x_0)^2 + (y - y_0)^2 =
r^2 (z - z_0)^2`.

.. Note::
This creates a double cone, which is two "traditional" cones that meet at their apex.
For a "traditional" cone see :class:`~openmc.model.ZConeSided`.
MicahGale marked this conversation as resolved.
Show resolved Hide resolved

Parameters
----------
x0 : float, optional
Expand All @@ -2099,7 +2122,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. Defaults to 1.
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.
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