LatticeAtom

class sknano.core.atoms.lattice_atoms.LatticeAtom(*args, lattice=None, xs=None, ys=None, zs=None, **kwargs)

Bases: sknano.core.atoms.atoms.Atom

An Atom sub-class with crystal lattice attributes.

Parameters:

• lattice (Crystal3DLattice) –
• ys, zs (xs,) –

Attributes

Z	Atomic number \(Z\).
element	Element symbol.
fmtstr	Format string.
lattice	Crystal3DLattice.
m	An alias for mass.
mass	Atomic mass \(m_a\) in atomic mass units.
rs	Scaled \(x, y, z\) components of Atom position vector.
symbol	Element symbol.
xs	Scaled \(x\)-coordinate.
ys	Scaled \(y\)-coordinate.
zs	Scaled \(z\)-coordinate.

Methods

getattr(attr[, default, recursive])	Get atom attribute named attr.
reset_attrs(**kwargs)	Reset atom attributes.
rezero(*args, **kwargs)
todict()	Return dict of constructor parameters.
update_attrs(**kwargs)	Update atom attributes.

Attributes Summary

lattice	Crystal3DLattice.
rs	Scaled \(x, y, z\) components of Atom position vector.
xs	Scaled \(x\)-coordinate.
ys	Scaled \(y\)-coordinate.
zs	Scaled \(z\)-coordinate.

Methods Summary

todict()

Return dict of constructor parameters.

Attributes Documentation

lattice

Crystal3DLattice.

rs

Scaled \(x, y, z\) components of Atom position vector.

Returns:3-element ndarray of [\(x_s, y_s, z_s\)] coordinates of Atom. Return type:ndarray

xs

Scaled \(x\)-coordinate.

Returns:Scaled \(x\)-coordinate. Return type:float

ys

Scaled \(y\)-coordinate.

Returns:Scaled \(y\)-coordinate. Return type:float

zs

Scaled \(z\)-coordinate.

Returns:Scaled \(z\)-coordinate. Return type:float

Methods Documentation

todict()

Return dict of constructor parameters.