Skip to content

Shortcut: XSPRINT

Module xsprint
Description Usage
Calculate eXtended SPRINT (xSPRINT) topological variables from adjacency matrices over multiple shells. used in 0 tutorialsused in 0 eggs

Details and examples

Calculate eXtended SPRINT (xSPRINT) topological variables from adjacency matrices over multiple shells.

The xSPRINT coordinates, introduced in \cite ketkaew2022, extend the standard SPRINT coordinates by incorporating structural information from multiple concentric spherical shells around each atom. For a system divided into shells, the xSPRINT coordinate of atom is defined as:

where is the SPRINT coordinate computed from the adjacency matrix of the -th shell, is the shell radius, is the user-defined cutoff for the first shell, and is a normalization weight. Adjacency matrix elements from inner shells are zeroed out before computing each shell's SPRINT to avoid redundancy.

When NSHELLS=1 the xSPRINT coordinate reduces to the standard SPRINT coordinate.

The following example computes the xSPRINT coordinates for a 7-atom cluster using 3 shells with a shell radius of 0.1:

Click on the labels of the actions for more information on what each action computes
tested on2.11
xs: XSPRINTCalculate eXtended SPRINT (xSPRINT) topological variables from adjacency matrices over multiple shells. This action is a shortcut. More details GROUPspecifies the list of atoms that should be assumed indistinguishable=1-7 SWITCHspecify the switching function to use between two sets of indistinguishable atoms={RATIONAL R_0=0.1} R0the radius of the first shell for xSPRINT (shell n has radius n*R0)=0.1 NSHELLS the number of concentric shells to use for the xSPRINT calculation=3
PRINTPrint quantities to a file. More details ARGthe labels of the values that you would like to print to the file=xs.* FILEthe name of the file on which to output these quantities=colvar

Note that R0 defines the xSPRINT shell radius ( in the equation) and is independent of R_0 inside SWITCH, which controls the shape of the switching function. For shell , the switching function R_0 is automatically set to R0.

This example computes xSPRINT with 2 shells for two groups of atoms:

Click on the labels of the actions for more information on what each action computes
tested on2.11
xs: XSPRINTCalculate eXtended SPRINT (xSPRINT) topological variables from adjacency matrices over multiple shells. This action is a shortcut. More details ...
  GROUP1specifies the list of atoms that should be assumed indistinguishable=1-7 GROUP2specifies the list of atoms that should be assumed indistinguishable=8-14
  SWITCH11specify the switching function to use between two sets of indistinguishable atoms={RATIONAL R_0=2.6 NN=6 MM=12}
  SWITCH12specify the switching function to use between two sets of indistinguishable atoms={RATIONAL R_0=2.2 NN=6 MM=12}
  SWITCH22specify the switching function to use between two sets of indistinguishable atoms={RATIONAL R_0=2.2 NN=6 MM=12}
  R0the radius of the first shell for xSPRINT (shell n has radius n*R0)=2.0
  NSHELLS the number of concentric shells to use for the xSPRINT calculation=2
...

PRINTPrint quantities to a file. More details ARGthe labels of the values that you would like to print to the file=xs.* FILEthe name of the file on which to output these quantities=colvar

You can also provide a pre-built matrix (for a single-shell case this is equivalent to SPRINT):

Click on the labels of the actions for more information on what each action computes
tested on2.11
b: BRIDGE_MATRIXCalculate the number of atoms that bridge two parts of a structure This action has hidden defaults. More details GROUPthe atoms for which you would like to calculate the adjacency matrix=1-7 BRIDGING_ATOMSThe list of atoms that can form the bridge between the two interesting parts of the structure=8-100 SWITCHThe parameters of the two switching functions in the above formula. Options for this keyword are explained in the documentation for LESS_THAN.={RATIONAL R_0=0.2}
xs: XSPRINTCalculate eXtended SPRINT (xSPRINT) topological variables from adjacency matrices over multiple shells. This action is a shortcut. More details MATRIXthe matrix that you would like to perform xSPRINT on (used only when NSHELLS=1)=b NSHELLS the number of concentric shells to use for the xSPRINT calculation=1
PRINTPrint quantities to a file. More details ARGthe labels of the values that you would like to print to the file=xs.* FILEthe name of the file on which to output these quantities=colvar

Full list of keywords

The following table describes the keywords and options that can be used with this action

Keyword Type Default Description
NSHELLS compulsory 1 the number of concentric shells to use for the xSPRINT calculation
MATRIX optional not used the matrix that you would like to perform xSPRINT on (used only when NSHELLS=1)
GROUP optional not used specifies the list of atoms that should be assumed indistinguishable
SWITCH optional not used specify the switching function to use between two sets of indistinguishable atoms
R0 optional not used the radius of the first shell for xSPRINT (shell n has radius n*R0)

References

More information about how this action can be used is available in the following articles: