Cube¶
-
class
sisl.shape.
Cube
(side, center=None)[source]¶ 3D Cube with equal sides
Equivalent to
Cuboid([r, r, r])
.Parameters: - side : float
side-length of the cube, or vector
Attributes
center
The geometric center of the shape edge_length
The lengths of each of the vector that defines the cuboid origo
Return the origin of the Cuboid (lower-left corner) Methods
__init__
(side[, center])Initialize self. copy
()expand
(length)Expand the cuboid by a constant value along side vectors scale
(scale)Scale the cuboid box size (center is retained) set_center
(center)Re-setting the center can sometimes be necessary set_origo
(origo)Re-setting the origo can sometimes be necessary toCuboid
()Return a copy of itself toEllipsoid
()Return an ellipsoid that encompass this cuboid toSphere
()Return a sphere that encompass this cuboid volume
()Return volume of Cuboid within
(other)Return True
if other is fully within selfwithin_index
(other)Return indices of the other object which are contained in the shape -
center
¶ The geometric center of the shape
-
copy
()¶
-
edge_length
¶ The lengths of each of the vector that defines the cuboid
-
expand
(length)¶ Expand the cuboid by a constant value along side vectors
Parameters: - length : float or (3,)
the extension in Ang per cuboid vector.
-
origo
¶ Return the origin of the Cuboid (lower-left corner)
-
scale
(scale)¶ Scale the cuboid box size (center is retained)
Parameters: - scale : float or (3,)
the scale parameter for each of the vectors defining the
Cuboid
-
set_center
(center)¶ Re-setting the center can sometimes be necessary
-
set_origo
(origo)¶ Re-setting the origo can sometimes be necessary
-
toCuboid
()¶ Return a copy of itself
-
toEllipsoid
()¶ Return an ellipsoid that encompass this cuboid
-
toSphere
()¶ Return a sphere that encompass this cuboid
-
volume
()¶ Return volume of Cuboid
-
within
(other)¶ Return
True
if other is fully within selfIf other is an array, an array will be returned for each of these.
Parameters: - other : array_like
the array/object that is checked for containment
-
within_index
(other)¶ Return indices of the other object which are contained in the shape
Parameters: - other : array_like
the object that is checked for containment