crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 21:55:41 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Fix documentation typo in boundary_type (#3196)

Browse source
This commit is contained in:
Patrick Shriwise 2024-11-12 14:58:15 -06:00 • committed by GitHub
parent c9207795d8
commit 3e2a042eb1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 33 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

66
openmc/surface.py
View file

@ -119,7 +119,7 @@ class Surface(IDManagerMixin, ABC):
surface_id : int, optional
Unique identifier for the surface. If not specified, an identifier will
automatically be assigned.
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}, optional
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional
Boundary condition that defines the behavior for particles hitting the
surface. Defaults to transmissive boundary condition where particles
freely pass through the surface. Note that periodic boundary conditions
@ -135,7 +135,7 @@ class Surface(IDManagerMixin, ABC):
Attributes
----------
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -683,7 +683,7 @@ class Plane(PlaneMixin, Surface):
The 'C' parameter for the plane. Defaults to 0.
d : float, optional
The 'D' parameter for the plane. Defaults to 0.
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}, optional
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional
Boundary condition that defines the behavior for particles hitting the
surface. Defaults to transmissive boundary condition where particles
freely pass through the surface.
@ -707,7 +707,7 @@ class Plane(PlaneMixin, Surface):
The 'C' parameter for the plane
d : float
The 'D' parameter for the plane
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -818,7 +818,7 @@ class XPlane(PlaneMixin, Surface):
----------
x0 : float, optional
Location of the plane in [cm]. Defaults to 0.
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}, optional
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional
Boundary condition that defines the behavior for particles hitting the
surface. Defaults to transmissive boundary condition where particles
freely pass through the surface. Only axis-aligned periodicity is
@ -837,7 +837,7 @@ class XPlane(PlaneMixin, Surface):
----------
x0 : float
Location of the plane in [cm]
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -883,7 +883,7 @@ class YPlane(PlaneMixin, Surface):
----------
y0 : float, optional
Location of the plane in [cm]
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}, optional
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional
Boundary condition that defines the behavior for particles hitting the
surface. Defaults to transmissive boundary condition where particles
freely pass through the surface. Only axis-aligned periodicity is
@ -902,7 +902,7 @@ class YPlane(PlaneMixin, Surface):
----------
y0 : float
Location of the plane in [cm]
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -948,7 +948,7 @@ class ZPlane(PlaneMixin, Surface):
----------
z0 : float, optional
Location of the plane in [cm]. Defaults to 0.
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}, optional
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional
Boundary condition that defines the behavior for particles hitting the
surface. Defaults to transmissive boundary condition where particles
freely pass through the surface. Only axis-aligned periodicity is
@ -967,7 +967,7 @@ class ZPlane(PlaneMixin, Surface):
----------
z0 : float
Location of the plane in [cm]
boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -1197,7 +1197,7 @@ class Cylinder(QuadricMixin, Surface):
dz : float, optional
z-component of the vector representing the axis of the cylinder.
Defaults to 1.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -1228,7 +1228,7 @@ class Cylinder(QuadricMixin, Surface):
y-component of the vector representing the axis of the cylinder
dz : float
z-component of the vector representing the axis of the cylinder
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -1372,7 +1372,7 @@ class XCylinder(QuadricMixin, Surface):
z-coordinate for the origin of the Cylinder in [cm]. Defaults to 0
r : float, optional
Radius of the cylinder in [cm]. Defaults to 1.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -1395,7 +1395,7 @@ class XCylinder(QuadricMixin, Surface):
z-coordinate for the origin of the Cylinder in [cm]
r : float
Radius of the cylinder in [cm]
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -1470,7 +1470,7 @@ class YCylinder(QuadricMixin, Surface):
z-coordinate for the origin of the Cylinder in [cm]. Defaults to 0
r : float, optional
Radius of the cylinder in [cm]. Defaults to 1.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -1493,7 +1493,7 @@ class YCylinder(QuadricMixin, Surface):
z-coordinate for the origin of the Cylinder in [cm]
r : float
Radius of the cylinder in [cm]
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -1568,7 +1568,7 @@ class ZCylinder(QuadricMixin, Surface):
y-coordinate for the origin of the Cylinder in [cm]. Defaults to 0
r : float, optional
Radius of the cylinder in [cm]. Defaults to 1.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -1591,7 +1591,7 @@ class ZCylinder(QuadricMixin, Surface):
y-coordinate for the origin of the Cylinder in [cm]
r : float
Radius of the cylinder in [cm]
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -1667,7 +1667,7 @@ class Sphere(QuadricMixin, Surface):
z-coordinate of the center of the sphere in [cm]. Defaults to 0.
r : float, optional
Radius of the sphere in [cm]. Defaults to 1.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -1691,7 +1691,7 @@ class Sphere(QuadricMixin, Surface):
z-coordinate of the center of the sphere in [cm]
r : float
Radius of the sphere in [cm]
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -1784,7 +1784,7 @@ class Cone(QuadricMixin, Surface):
surface_id : int, optional
Unique identifier for the surface. If not specified, an identifier will
automatically be assigned.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -1812,7 +1812,7 @@ class Cone(QuadricMixin, Surface):
y-component of the vector representing the axis of the cone.
dz : float
z-component of the vector representing the axis of the cone.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -1930,7 +1930,7 @@ class XCone(QuadricMixin, Surface):
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.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -1954,7 +1954,7 @@ class XCone(QuadricMixin, Surface):
z-coordinate of the apex in [cm]
r2 : float
Parameter related to the aperature
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -2031,7 +2031,7 @@ class YCone(QuadricMixin, Surface):
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.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -2055,7 +2055,7 @@ class YCone(QuadricMixin, Surface):
z-coordinate of the apex in [cm]
r2 : float
Parameter related to the aperature
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -2132,7 +2132,7 @@ class ZCone(QuadricMixin, Surface):
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_type : {'transmission', 'vacuum', 'reflective', 'white'}, optional
Boundary condition that defines the behavior for particles hitting the
surface. Defaults to transmissive boundary condition where particles
freely pass through the surface.
@ -2156,7 +2156,7 @@ class ZCone(QuadricMixin, Surface):
z-coordinate of the apex in [cm]
r2 : float
Parameter related to the aperature
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -2221,7 +2221,7 @@ class Quadric(QuadricMixin, Surface):
----------
a, b, c, d, e, f, g, h, j, k : float, optional
coefficients for the surface. All default to 0.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
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
freely pass through the surface.
@ -2239,7 +2239,7 @@ class Quadric(QuadricMixin, Surface):
----------
a, b, c, d, e, f, g, h, j, k : float
coefficients for the surface
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -2391,7 +2391,7 @@ class XTorus(TorusMixin, Surface):
Minor radius of the torus in [cm] (parallel to axis of revolution)
c : float
Minor radius of the torus in [cm] (perpendicular to axis of revolution)
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -2466,7 +2466,7 @@ class YTorus(TorusMixin, Surface):
Minor radius of the torus in [cm] (parallel to axis of revolution)
c : float
Minor radius of the torus (perpendicular to axis of revolution)
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float
@ -2541,7 +2541,7 @@ class ZTorus(TorusMixin, Surface):
Minor radius of the torus in [cm] (parallel to axis of revolution)
c : float
Minor radius of the torus in [cm] (perpendicular to axis of revolution)
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}
boundary_type : {'transmission', 'vacuum', 'reflective', 'white'}
Boundary condition that defines the behavior for particles hitting the
surface.
albedo : float