sknano.core.atoms.DipoleAtom

class sknano.core.atoms.DipoleAtom(*args, *, px=None, py=None, pz=None, **kwargs)

An Atom class with electric dipole moment attributes.

Parameters:

element : {str, int}, optional

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

px, py, pz : float, optional

\(p_x, p_y, p_z\) components of DipoleAtom dipole moment.

Attributes

Z	Atomic number \(Z\).
element	Element symbol.
fmtstr	Format string.
m
mass	Atomic mass \(m_a\) in atomic mass units.
p	Dipole moment \(\mathbf{p}=q\mathbf{d}\).
px	\(x\) component of DipoleAtom dipole moment vector
py	\(x\) component of DipoleAtom dipole moment vector
pz	\(z\) component of DipoleAtom dipole moment vector
symbol	Element symbol.

Methods

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