Shortcut: PAIRENTROPY
Module | gridtools |
---|---|
Description | Usage |
Calculate the KL Entropy from the radial distribution function | |
output value | type |
the KL-entropy that is computed from the radial distribution function | scalar |
Input
The atoms that serve as the input for this action are specified using one or more of the keywords in the following table.
Keyword | Type | Description |
---|---|---|
GROUP | atoms | the atoms that are being used to calculate the RDF |
ATOMS | atoms | the atoms that are being used to calculate the RDF |
GROUPA | atoms | the atoms that you would like to compute the RDF about |
GROUPB | atoms | the atoms that you would like to to use when computing the RDF around the atoms that were specified with GROUPA |
Further details and examples
Text from manual goes here
Syntax
The following table describes the keywords and options that can be used with this action
Keyword | Type | Default | Description |
---|---|---|---|
GROUP | input | none | the atoms that are being used to calculate the RDF |
ATOMS | input | none | the atoms that are being used to calculate the RDF |
GROUPA | input | none | the atoms that you would like to compute the RDF about |
GROUPB | input | none | the atoms that you would like to to use when computing the RDF around the atoms that were specified with GROUPA |
GRID_BIN | compulsory | none | the number of bins to use when computing the RDF |
KERNEL | compulsory | GAUSSIAN | the type of kernel to use for computing the histograms for the RDF |
CUTOFF | compulsory | 6.25 | the cutoff at which to stop evaluating the kernel functions is set equal to sqrt(2x)bandwidth in each direction where x is this number |
MAXR | compulsory | none | the maximum distance to use for the rdf |
BANDWIDTH | compulsory | none | the bandwidths for kernel density esimtation |
CLEAR | compulsory | 1 | the frequency with which to clear the estimate of the rdf |
STRIDE | compulsory | 1 | the frequency with which to compute the rdf and accumulate averages |
SIGMA | compulsory | use bandwidth | an alternative method for specifying the bandwidth instead of using the BANDWIDTH keyword |
DENSITY | optional | not used | the reference density to use when normalizing the RDF |