Cuboid

class sisl.shape.Cuboid(edge_length, center=None)

A cuboid/rectangular prism (P4) with equi-opposite faces

Attributes

center	The geometric center of the shape
displacement	Return the displacement vector of the Cuboid
edge_length	Return the edge-length of the Cuboid
origo	Return the origin of the Cuboid (lower-left corner)
volume	Return the edge-length of the Cuboid

Methods

__init__(edge_length[, 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 other object which are contained in the shape
set_center(center)	Re-setting the center can sometimes be necessary
set_origo(origo)	Re-setting the origo can sometimes be necessary
within(other)	Return a True/False value of whether the other object is contained in this shape

center

The geometric center of the shape

displacement

Return the displacement vector of the Cuboid

edge_length

Return the edge-length of the Cuboid

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 other object which are contained in the shape

Parameters:

other : (numpy.ndarray, list, tuple)

the object that is checked for containment

origo

Return the origin of the Cuboid (lower-left corner)

set_center(center)

Re-setting the center can sometimes be necessary

set_origo(origo)

Re-setting the origo can sometimes be necessary

volume

Return the edge-length of the Cuboid

within(other)

Return a True/False value of whether the other object is contained in this shape

Parameters:

other : (numpy.ndarray, list, tuple)

the object that is checked for containment