PBCAtomsMixin

class sknano.core.atoms.PBCAtomsMixin(*args, xperiodic=False, yperiodic=False, zperiodic=False, **kwargs)

Bases: object

Mixin Atoms class for PBC.

Parameters:yperiodic, zperiodic (xperiodic,) – True for PBC along the given dimension. Default is False.

Attributes

pbc	Return boolean array of periodic boundaries set along x,y,z axes.
xperiodic	Return True if periodic along the x axis.
yperiodic	Return True if periodic along the y axis.
zperiodic	Return True if periodic along the z axis.

Methods

set_pbc(dims)	Set periodic boundaries along dims.
unset_pbc()	Turn of PBCs along all dimensions.

Attributes Summary

pbc	Return boolean array of periodic boundaries set along x,y,z axes.
xperiodic	Return True if periodic along the x axis.
yperiodic	Return True if periodic along the y axis.
zperiodic	Return True if periodic along the z axis.

Methods Summary

set_pbc(dims)	Set periodic boundaries along dims.
unset_pbc()	Turn of PBCs along all dimensions.

Attributes Documentation

pbc

Return boolean array of periodic boundaries set along x,y,z axes.

Returns:Returns a bool ndarray of the xperiodic, yperiodic, zperiodic bool attributes. Return type:ndarray

xperiodic

Return True if periodic along the x axis.

yperiodic

Return True if periodic along the y axis.

zperiodic

Return True if periodic along the z axis.

Methods Documentation

set_pbc(dims)

Set periodic boundaries along dims.

Parameters:dims (str) –

unset_pbc()

Turn of PBCs along all dimensions.