Shortcut: INENVELOPE
Module | volumes |
---|---|
Description | Usage |
This quantity can be used to calculate functions of the distribution of collective variables for the atoms that lie in a region where the density of a certain type of atom is high. | |
output value | type |
sum of values of input CVs in regin of interest | scalar |
Output components
This action can calculate the values in the following table when the associated keyword is included in the input for the action. These values can be referenced elsewhere in the input by using this Action's label followed by a dot and the name of the value required from the list below.
Name | Type | Keyword | Description |
---|---|---|---|
lessthan | scalar | LESS_THAN | the number of cvs in the region of interest that are less than a certain threshold |
morethan | scalar | MORE_THAN | the number of cvs in the region of interest that are more than a certain threshold |
between | scalar | BETWEEN | the number of cvs in the region of interest that are within a certain range |
sum | scalar | SUM | the sum of all the colvars weighted by the function that determines if we are in the region |
mean | scalar | MEAN | the average values of the colvar in the region of interest |
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 |
---|---|---|
ATOMS | atoms | the group of atoms that you would like to investigate |
FIELD_ATOMS | atoms | the atom whose positions we are constructing a field from |
Further details and examples
This quantity can be used to calculate functions of the distribution of collective variables for the atoms that lie in a region where the density of a certain type of atom is high.
This collective variable can be used to determine whether atoms are within region where the density of a particular atom type is high. This is achieved by calculating the following function at the point where each atom is located (xi,yi,zi):
wi=1−σ[N∑i=1K(x−xiσx,y−yiσy,z−ziσz)]
Here σ is one of the switching functions that is discussed in the documentation for the action LESS_THAN and K is one of the kernel functions that is discussed in the documentation for the action BETWEEN. The sum runs over the atoms specified using the FIELD_ATOMS keyword and a wj value is calculated for each of the central atoms of the input multicolvar.
The input below shows how this action works in practise. This input calculates a density field from the positions of atoms 1-14400. A vector which has as many elements as atoms that were specified using the ATOMS keyword. The ith element of this vector is calculated using the expression above with (xi,yi,zi) being the position of the ith atom that was specified using that ATOMS keyword.
fiINENVELOPEThis quantity can be used to calculate functions of the distribution of collective variables for the atoms that lie in a region where the density of a certain type of atom is high. More details ATOMSthe group of atoms that you would like to investigate=14401-74134:3 FIELD_ATOMSthe atom whose positions we are constructing a field from=1-14400 CONTOURa switching funciton that tells PLUMED how large the density should be={RATIONAL D_0=2.0 R_0=1.0} BANDWIDTHthe bandwidths for kernel density esimtation=0.1,0.1,0.1 PRINTPrint quantities to a file. More details ARGthe labels of the values that you would like to print to the file=fi FILEthe name of the file on which to output these quantities=colvar:
This particular action was developed with the intention of determining whether water molecules had penetrated a membrane or not. The FIELD_ATOMS were thus the atoms of the lipid molecules that made up the membrane and the ATOMS were the oxygens of the water molecules. The vector that is output by this action can be used in all the ways that the vector that is output by the AROUND action is used. In other words, this action can be used to calculate the number of water molecules in the membrane or the average values for a symmetry function for those atoms that are within the membrane.
Syntax
The following table describes the keywords and options that can be used with this action
Keyword | Type | Default | Description |
---|---|---|---|
ATOMS | input | none | the group of atoms that you would like to investigate |
FIELD_ATOMS | input | none | the atom whose positions we are constructing a field from |
KERNEL | compulsory | gaussian | the type of kernel function to be used |
BANDWIDTH | compulsory | none | the bandwidths for kernel density esimtation |
CONTOUR | compulsory | none | a switching funciton that tells PLUMED how large the density should be |
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 |
SERIAL | optional | false | do the calculation in serial |
OUTSIDE | optional | false | calculate quantities for colvars that are on atoms outside the region of interest |
DATA | optional | not used | the label of an action that calculates multicolvars |
LESS_THAN | optional | not used | calcualte the number of colvars that are inside the region of interest and that are less than a certain threshold |
MORE_THAN | optional | not used | calcualte the number of colvars that are inside the region of interest and that are greater that a certain threshold |
BETWEEN | optional | not used | calculate the number of colvars that are inside the region of interest and that have a CV value that is between a particular set of bounds |
SUM | optional | false | calculate the sum of all the quantities |
MEAN | optional | false | calculate the average value of the colvar inside the region of interest |