add description of surfaces

This commit is contained in:
yardasol 2022-04-26 13:49:21 -05:00
parent be97beb1c4
commit 5abd01d4df

View file

@ -56,6 +56,10 @@ class CompositeSurface(ABC):
class CylinderSector(CompositeSurface):
"""Infinite cylindrical sector composite surface
A cylinder sector is composed of two cylindrical and two planar surfaces.
The cylindrical surfaces are concentric, and the planar surfaces intersect
the central axis of the cylindrical surfaces.
This class acts as a proper surface, meaning that unary `+` and `-`
operators applied to it will produce a half-space. The negative
side is defined to be the region inside of the cylinder sector.