5.4 Keywords of file tcontrol

All keywords (tags) of tcontrol file begin with a special symbol $. Lines starting from # are comment lines. All lines after a keyword $end are ignored.

 

Tag: $aims_input(tcontrol)

Usage: $aims_input on
Purpose: mandatory flag, sets up the FHI-aims like format of input/output files.

 

Tag: $landauer(tcontrol)

Usage: $landauerflag
Purpose: mandatory keyword; flag should take values either on or off. If flag is on, ballistic transmission function is computed. If flag is off, calculation of the transmission function is not performed. In this case you, however, may wish to compute atom projected local density of states that is controlled by the keyword $ldos.

 

Tag: $ldos(tcontrol)

Usage: $ldosflag
Purpose: optional keyword; flag can take values on or off. If flag is on, atom projected local density of states (LDoS) is computed; otherwise (flag is off) calculation of LDOS is not performed.

On output, the (energy dependent) density of states of the system is projected onto atomic orbitals of atoms marked by the same chemical symbols and is redirected to corresponding files, which have the self-explanatory names, e.g. ldos.au.dat, ldos.c.dat, ldos.h.dat and ldos.s.dat in the case of benzene-dithiol molecular junction shown in Fig. 5.1. For example, the file ldos.c.dat would contain LDoS summed up over all six C atoms of the molecule. Furthermore, only LDoS projected onto those electrodes’ atoms of the “extended molecule” which are not part of the interfaces to the reservoirs (shown in grey color in Fig. 5.1) is redirected to the file ldos.au.dat.

Data in the output files are arranged in columns as indicated in the file’s header, namely: energy in Hartree (atomic) units; energy in eV units given with respect to the Fermi energy; LDoS (in 1/eV units) in the α spin channel; if open shell calculation is chosen, next column contains LDoS (in 1/eV units) in the β spin channel; last column contains LDoS summed up over two spin channels.

There is a possibility to arrange atoms having the same chemical symbol in groups by using the sixth field of the line staring from ’atom’ as appears, e.g., in the geometry.in file (see also a keyword $coord). For example, LDoS projected on the two Au atoms indicated by the mask ’apex’ as shown in the example below,

 atom    0.1424445    0.1134435    4.4557346    Au   apex
 ...
 atom   -0.1689195    0.0042317   -4.4601905    Au   apex
 

would appear in the file ldos.au_apex.dat. Caution: maximum 16 characters can be used to designate a group of atoms.

 

Tag: $coord(tcontrol)

Usage: $coordfile=geo-filename
Purpose: mandatory keyword; sets up a file name with atomic positions (in FHI-aims format); geo-filename is a text string without spacings, e.g., geometry.in

A specified file should be present in your directory. The whole string, file=geo-filename, should not contain any spacings.

 

Tag: $natoms(tcontrol)

Usage: $natomsn
Purpose: mandatory keyword, specifies number of atoms in the “extended molecule”; n is a positive integer number.

 

Tag: $basis(tcontrol)

Usage: $basisfile=basis-filename
Purpose: mandatory keyword; sets up a file name with information on basis functions quantum numbers as written out by the FHI-aims; basis-filename is a text string without spacings, default file name is basis-indices.out

A specified file should be present in your directory. The string file=basis-filename should not contain spacings.

 

Tag: $read_omat(tcontrol)

Usage: $read_omatfile=overlap-filename
Purpose: mandatory keyword, sets up a file name with overlap matrix elements as written out by the FHI-aims; overlap-filename is a text string without spacings, default file name is omat.aims.

A specified file should be present in your directory. The string file=basis-filename should not contain spacings.

 

Tag: $scfmo(tcontrol)

Usage: $scfmofile=mos-filename
Purpose: mandatory keyword in case of non-spin-polarized calculation; sets up a file name with self-consistent-field molecular orbitals (e.g., Kohn-Sham wave functions) as written out by the FHI-aims; mos-filename is a text string without spacings, default file name is mos.aims.

A specified file should be present in your directory. The string file=mos-filename should not contain spacings.

 

Tags: $uhfmo_alpha
$uhfmo_beta(tcontrol)

Usage:  $uhfmo_alphafile=alpha-filename
Usage: $uhfmo_betaafile=beta-filename
Purpose: mandatory keywords in case of spin-polarized calculation; set up file names with self-consistent-field molecular orbitals (e.g., Kohn-Sham wave functions) as written out by the FHI-aims for α (up-spin) and β (down-spin) electrons, respectively; alpha-filename and beta-filename are text strings without spacings, default file names are alpha.aims and beta.aims.

Specified files should be present in your directory. The strings file=alpha-filename and file=beta-filename should not contain spacings.

 

Tag: $nsaos(tcontrol)

Usage: $nsaosN
Purpose: mandatory keyword, specifies dimension N of the overlap matrix and a single-particle Hamiltonian of the “extended molecule”.
N is a positive integer number; its value can be found in the header line of default output FHI-aims files omat.aims and mos.aims (or alpha.aims and beta.aims).

 

Tag: $ecp(tcontrol)

Usage: $ecpflag
Purpose: optional keyword, flag can take values on or off. Default (and recommended) value is set to on and serves to substantially accelerate electron transport calculations.

In that case, exploiting Green’s function formalism, "core" electronic states of atoms with Z19 are integrated out and projected on a subspace of the remaining ("valence") electronic states. Thus, dimension of the effective Hilbert space of the "extended molecule" is reduced (see $valence_electrons), and only valence states are coupled to macroscopic reservoirs via model self-energies. For atoms from the n-th period of the periodic table, core states are associated with those "atomic" basis functions, which have the principle quantum numbers up to n2.

 

Tag: $valence_electrons(tcontrol)

Usage: $valence_electronsNval
Purpose: optional keyword, Nval is integer number, which is evaluated automatically and specifies amount of valence states in the "extended molecule" when a keyword $ecp is switched on.

 

Tags: $lsurc
$lsurx
$lsury(tcontrol)

Usage: $lsurc n1
Usage: $lsurx n2
Usage: $lsury n3
Purpose: mandatory keywords; integer numbers n1, n2 and n3 are indices of three different atoms according to their appearance in file geometry.in, which define in a unique way an outermost left atomic surface of the “extended molecule” (see Fig. 5.1 for details).

 

Tags: $rsurc
$rsurx
$rsury(tcontrol)

Usage: $rsurc m1
Usage: $rsurx m2
Usage: $rsury m3
Purpose: mandatory keywords; integer numbers m1, m2 and m3 are indices of three different atoms according to their appearance in file geometry.in, which define in a unique way an outermost right atomic surface of the “extended molecule” (see Fig. 5.1 for details).

 

Tag: $nlayers(tcontrol)

Usage: $nlayersNa
Purpose: integer number Na specifies amount of atomic layers within interface regions at the boundaries of “extended molecule” where absorbing boundary conditions are active and self-energy matrix elements (leakage rates) are non-zeros, see Fig. 5.1 for details.

An integer number Na should be taken from a header line of library files for Au electrodes which are placed in electrodes.library/ directory.

When using tcontrol.aims.x, the number Na is passed to a script by the option: -nlayers Na.

 

Tags: $s1i
$s2i
$s3i(tcontrol)

Usage: $s1i η1
Usage: $s2i η2
Usage: $s3i η3
Purpose: positive real numbers η1, η2 and η3 define local leakage rates (in Hartree units) which parametrize self-energy matrix elements.

Default values of leakage rates for Au clusters, written by the script tcontrol.aims.x to the file tcontrol, reflect a gradual switching of perturbation and are given by: η1=0.1 for the outermost atomic layer of the “extended molecule” (see Fig. 5.1 for details); η2=0.05 for the next-to-the-outermost atomic layer; and η3=0.025 for the rest of atomic layers within the interface regions of the “extended molecule”.

See also a keyword $self_energy.

Disclaimer: ’Black-box’-users of aitranss are strongly advised to work with the Au-electrodes listed in the library and use default parameters for the self-energy, only. The transport code will print out a warning message if other chemical elements are employed as electrodes material. Unexpected modification of electrodes or self-energy settings will, in general, lead to misleading or incorrect scientific results.

 

Tags: $ener
$estep
$eend(tcontrol)

Usage: $eneraE1
Usage: $estepdE
Usage: $eendaE2
Purpose: real numbers E1, dE and E2 should be given in Hartree units and define the energy window [E1,E2], and the energy step dE for calculation and output of the transmission function T(E).

If any of above mentioned keywords is missing, only conductance at the Fermi energy is calculated.

 

Tag: $self_energy(tcontrol)

Usage: $self_energyfile=self-energy-file
Purpose: sets up a name of the file with atom specific values parameterizing the self-energy matrix; a format of the self-energy file is explained in section 5.3.4.
self-energy-file is a text string, a default file name is self.energy.in. The string file=self-energy-file should not contain spacings.

If a keyword $self_energy is present in tcontrol, the diagonal elements of the self-energy matrix are read from the referenced file. In that case, parameters and values given by keywords $lsurc, $lsurx, $lsury, $rsurc, $rsurx, $rsury, $nlayers, $s1i, $s2i, and $s3i do not have an effect.

 

Tag: $testing(tcontrol)

Usage: $testingflag
Purpose: optional keyword, reserved for testing purposes; flag can take values on or off. Default value is set to off.

If flag is set to on, several internal checks are performed to insure that employed numerical procedures give correct results, e.g.: (i) eigenvalues of the reconstructed Kohn-Sham Hamiltonian H coincide with values stored in files mos.aims, alpha.aims or beta.aims, and eigenvectors of H are orthogonal to each other; (ii) eigenvalues of the overlap matrix are positive, and the square-root of the overlap matrix multiplied by itself gives back the overlap matrix; (iii) a matrix B of eigenvectors of the complex valued operator H+Σ multiplied by the inverse B1 gives a unitary matrix, BB1=1, etc. Furthermore, there appear many .tmp files: one of them called zmos.tmp (or zalpha.tmp and zbeta.tmp) contains information on the complex poles En=εniδn of the Green’s function G1(E)=EHΣ.

 

Tag: $end(tcontrol)

Usage: $end
Purpose: mandatory keyword, indicates the last line of file tcontrol, which is read by the transport module aitranss. All lines below this one are ignored.

Acknowledgment: A. Bagrets and F. Evers acknowledge the help of Richard Korytár in writing a manual on aitranss.