sisl.shape.NullShape

class sisl.shape.NullShape(*args, **kwargs)

Bases: sisl.shape.PureShape

A unique shape which has no well-defined spatial volume or center

This special shape is used when composite shapes turns out to have a null space.

The center will be equivalent to the maximum floating point value divided by 100.

Initialization of the NullShape takes no (or any) arguments. Since it has no volume of point in space, none of the arguments has any meaning.

Methods

expand(c)	Expand the shape by a constant value
scale(scale)	Return a new Shape with a scaled size
toCuboid()	Return a cuboid with side-lengths 1e-64
toEllipsoid()	Return an ellipsoid with radius of size 1e-64
toSphere()	Return a sphere with radius of size 1e-64
volume(*args, **kwargs)	The volume of a null shape is exactly 0.
within(other, *args, **kwargs)	Return True if other is fully within self
within_index(other, *args, **kwargs)	Always returns a zero length array
center	The geometric center of the shape

__init__(*args, **kwargs)

Initialize a null-shape

property center

The geometric center of the shape

expand(c)

Expand the shape by a constant value

scale(scale)

Return a new Shape with a scaled size

toCuboid()

Return a cuboid with side-lengths 1e-64

toEllipsoid()

Return an ellipsoid with radius of size 1e-64

toSphere()

Return a sphere with radius of size 1e-64

volume(*args, **kwargs)

The volume of a null shape is exactly 0.

within(other, *args, **kwargs)

Return True if other is fully within self

If 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

• *args – passed directly to within_index

• **kwargs – passed directly to within_index

within_index(other, *args, **kwargs)

Always returns a zero length array