Name

Spin.Type Used to distinguish between which part (Spin.Up, Spin.Down or both) that should be treated in a given calculation.

Synopsis

Namespace: ATK.KohnSham or ATK.TwoProbe

Description

Spin.Up (↑) and Spin.Down (↓) are singleton values that take no options and return no values. Both are used to specify the spin quantum number when performing analysis on spin-polarized calculations.

Usage examples

Calculate the spin-up electron current:

from ATK.KohnSham import *

scf = executeSelfConsistentCalculation(...)
up_current = calculateCurrent(scf,spin = Spin.Up)
down_current = calculateCurrent(scf,spin = Spin.Down)

Notes

Spin.Up and Spin.Down are not used to assign values to spin. Instead, the spin unit hbar should be used. For further details, see electronDensityParameters().