Coordination number#

Evaluates a fractional coordination number for a given geometry or batch of geometries.

Examples

>>> import torch
>>> import tad_dftd3 as d3
>>> numbers = d3.util.pack((
...     torch.tensor([7, 1, 1, 1]),
...     torch.tensor([6, 8, 7, 1, 1, 1]),
...     torch.tensor([6, 8, 8, 1, 1]),
... ))
>>> positions = d3.util.pack((
...     torch.tensor([
...         [+0.00000000000000, +0.00000000000000, -0.54524837997150],
...         [-0.88451840382282, +1.53203081565085, +0.18174945999050],
...         [-0.88451840382282, -1.53203081565085, +0.18174945999050],
...         [+1.76903680764564, +0.00000000000000, +0.18174945999050],
...     ]),
...     torch.tensor([
...         [-0.55569743203406, +1.09030425468557, +0.00000000000000],
...         [+0.51473634678469, +3.15152550263611, +0.00000000000000],
...         [+0.59869690244446, -1.16861263789477, +0.00000000000000],
...         [-0.45355203669134, -2.74568780438064, +0.00000000000000],
...         [+2.52721209544999, -1.29200800956867, +0.00000000000000],
...         [-2.63139587595376, +0.96447869452240, +0.00000000000000],
...     ]),
...     torch.tensor([
...         [-0.53424386915034, -0.55717948166537, +0.00000000000000],
...         [+0.21336223456096, +1.81136801357186, +0.00000000000000],
...         [+0.82345103924195, -2.42214694643037, +0.00000000000000],
...         [-2.59516465056138, -0.70672678063558, +0.00000000000000],
...         [+2.09259524590881, +1.87468519515944, +0.00000000000000],
...     ]),
... ))
>>> rcov = d3.data.covalent_rad_d3[numbers]
>>> cn = d3.ncoord.coordination_number(numbers, positions, rcov, d3.ncoord.exp_count)
>>> torch.set_printoptions(precision=7)
>>> print(cn)
tensor([[2.9901006, 0.9977214, 0.9977214, 0.9977214, 0.0000000, 0.0000000],
        [3.0059586, 1.0318390, 3.0268824, 1.0061584, 1.0036336, 0.9989871],
        [3.0093639, 2.0046251, 1.0187057, 0.9978270, 1.0069743, 0.0000000]])
tad_dftd3.ncoord.coordination_number(numbers, positions, rcov=None, counting_function=<function exp_count>, cutoff=None, **kwargs)[source]#

Calculate the coordination number of each atom in the system.

Parameters
  • numbers (Tensor) – The atomic numbers of the atoms in the system.

  • positions (Tensor) – The positions of the atoms in the system.

  • rcov (Tensor) – Covalent radii for all atoms in the system.

  • counting_function (Callable) – Calculates counting value in range 0 to 1 from a batch of distances and covalent radii, additional parameters can be passed through via key-value arguments.

  • cutoff (float) – Real-space cutoff for the evaluation of counting function

Returns

Tensor

Return type

The coordination number of each atom in the system.

tad_dftd3.ncoord.exp_count(r, r0, kcn=16.0)[source]#

Exponential counting function for coordination number contributions.

Parameters
  • r (Tensor) – Current distance.

  • r0 (Tensor) – Cutoff radius.

  • kcn (float) – Steepness of the counting function.

Returns

Count of coordination number contribution.

Return type

Tensor