sisl.io.dftb.skfSileDFTB

class sisl.io.dftb.skfSileDFTB

Bases: SileDFTB

DFTB Slater-Koster file of the elements A and B, e.g. A-B.skf

Methods

base_directory([relative_to])

Retrieve the base directory of the file, relative to the path relative_to

close()

dir_file([filename, filename_base])

File of the current Sile

read(*args, **kwargs)

Generic read method which should be overloaded in child-classes

read_documentation()

The XML section <Documentation> of the file (author, elements, basis, ...)

read_slater_koster([shells])

Slater-Koster model of the species pair of this file, and of B-A.skf next to it

readlines([comment])

Read all lines in the sile

write(*args, **kwargs)

Generic write method which should be overloaded in child-classes

Attributes

base_file

File of the current Sile

file

File of the current Sile

base_directory(relative_to='.')

Retrieve the base directory of the file, relative to the path relative_to

close()
dir_file(filename=None, filename_base='')

File of the current Sile

read(*args, **kwargs)

Generic read method which should be overloaded in child-classes

Parameters:

kwargs – keyword arguments will try and search for the attribute read_<> and call it with the remaining **kwargs as arguments.

read_documentation()[source]

The XML section <Documentation> of the file (author, elements, basis, …)

An empty string if the file has no documentation.

Return type:

str

read_slater_koster(shells=None)[source]

Slater-Koster model of the species pair of this file, and of B-A.skf next to it

The elements come from the documentation of the file (read_documentation), and their order from the file name. The name of B-A.skf swaps only the two elements, e.g. N-H_short.skf and H-N_short.skf. The tags are the elements: a file with a suffix (N-H_short.skf) is another model of the same pair as N-H.skf. A file holds the integrals with the lower \(l\) on its first atom, thus a pair of two species needs both files. Integrals of equal \(l\) must agree in both files. A homonuclear file also gives the on-site energies. The model has the overlap integrals, thus it is non-orthogonal. The interpolation is that of DFTB+: a polynomial through 8 grid points, and a polynomial of 5th order to 0 in 1 Bohr after the last grid point.

Use merge to join the models of all species pairs.

Parameters:

shells (Mapping[str, Sequence[str]] | None) – the shell labels (<n><l>[Z<zeta>][P]) of each tag, one for each \(l\), e.g. {"O": ["2s", "2p"], "H": ["1s"]}. Only these shells get integrals. A tag without shells gets the <Basis> of its homonuclear file next to this file: X-X_short.skf for A-B_short.skf, else X-X.skf.

Return type:

SlaterKoster

Examples

>>> sk = sisl.SlaterKoster.merge(
...     *(sisl.get_sile(f).read_slater_koster() for f in ["O-O.skf", "O-H.skf", "H-H.skf"])
... )
readlines(comment=False)

Read all lines in the sile

Parameters:

comment (bool)

Return type:

str

write(*args, **kwargs)

Generic write method which should be overloaded in child-classes

Parameters:

**kwargs – keyword arguments will try and search for the attribute write_ and call it with the remaining **kwargs as arguments.

property base_file

File of the current Sile

property file

File of the current Sile