Spheroid¶
-
class
sisl.shape.
Spheroid
(a, b, axis=2, center=None)[source]¶ 3D spheroid shape
Parameters: a : float
the first spheroid axis radius
b : float
the second spheroid axis radius
axis : int
the symmetry axis of the Spheroid
Attributes
center
The geometric center of the shape displacement
Return the displacement vector of the Ellipsoid origo
The geometric origo of the shape radius
Return the radius of the Ellipsoid volume
Return the volume of the shape Methods
__init__
(a, b[, axis, center])enlarge
(length)Return a new Shape with an increased size length expand
(length)Return a new shape with a larger corresponding to length iwithin
(other)Return indices of the points that are within the shape set_center
(center)Change the center of the object within
(other)Return whether the points are within the shape -
center
¶ The geometric center of the shape
-
displacement
¶ Return the displacement vector of the Ellipsoid
-
enlarge
(length)¶ Return a new Shape with an increased size length
-
expand
(length)¶ Return a new shape with a larger corresponding to length
-
iwithin
(other)¶ Return indices of the points that are within the shape
-
origo
¶ The geometric origo of the shape
An origo should always be the lowest left coordinate of the shape.
Notes
Not all shapes have an origo. For instance a sphere only have a center, but an origo cannot be defined.
-
radius
¶ Return the radius of the Ellipsoid
-
volume
¶ Return the volume of the shape
-
within
(other)¶ Return whether the points are within the shape
-