sisl.shape.ellipsoid module¶
Implement a set of simple shapes that
-
class
sisl.shape.ellipsoid.
Ellipsoid
(x, y, z, center=None)[source]¶ Bases:
sisl.shape.shape.Shape
A 3D Ellipsoid shape
Parameters: x :
float
the radius along x-direction
y :
float
the radius along y-direction
z :
int
the radius along z-direction
Attributes
center
Return the geometric center of the shape displacement
Return the displacement vector of the Ellipsoid radius
Return the radius of the Ellipsoid volume
Return the volume of the shape Methods
__call__
(*args, **kwargs)Re-initialize the Shape 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_sub])Return indices of the points that are within the shape set_center
(center)Change the center of the object within
(other[, return_sub])Return whether the points are within the shape -
displacement
¶ Return the displacement vector of the Ellipsoid
-
radius
¶ Return the radius of the Ellipsoid
-
volume
¶ Return the volume of the shape
-
-
class
sisl.shape.ellipsoid.
Spheroid
(a, b, axis=2, center=None)[source]¶ Bases:
sisl.shape.ellipsoid.Ellipsoid
A 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
Return the geometric center of the shape displacement
Return the displacement vector of the Ellipsoid radius
Return the radius of the Ellipsoid volume
Return the volume of the shape Methods
__call__
(*args, **kwargs)Re-initialize the Shape 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_sub])Return indices of the points that are within the shape set_center
(center)Change the center of the object within
(other[, return_sub])Return whether the points are within the shape
-
class
sisl.shape.ellipsoid.
Sphere
(radius, center=None)[source]¶ Bases:
sisl.shape.ellipsoid.Spheroid
A sphere
Attributes
center
Return the geometric center of the shape displacement
Return the displacement vector of the Ellipsoid radius
Return the radius of the Ellipsoid volume
Return the volume of the shape Methods
__call__
(*args, **kwargs)Re-initialize the Shape 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_sub])Return indices of the points that are within the shape set_center
(center)Change the center of the object within
(other[, return_sub])Return whether the points are within the shape