sknano.core.atoms.VelocityAtom

class sknano.core.atoms.VelocityAtom(*args, *, vx=None, vy=None, vz=None, **kwargs)

An Atom class with velocity component attributes.

Parameters:

element : {str, int}, optional

A string representation of the element symbol or an integer specifying an element atomic number.

vx, vy, vz : float, optional

\(v_x, v_y, v_z\) components of VelocityAtom velocity.

Attributes

Z	Atomic number \(Z\).
element	Element symbol.
fmtstr	Format string.
m
mass	Atomic mass \(m_a\) in atomic mass units.
symbol	Element symbol.
v	\(v_x, v_y, v_z\) array of velocity components.
vx	\(x\) component of VelocityAtom velocity vector
vy	\(x\) component of VelocityAtom velocity vector
vz	\(z\) component of VelocityAtom velocity vector

Methods

rezero([epsilon])	Re-zero velocity vector components.
rotate(**kwargs)	Rotate Atom velocity vector.
todict()
translate(*args, **kwargs)