ABF:Controls: Difference between revisions
(Created page with "Navigation: Documentation / Methods / Adaptive Biasing Force Method / ABF:Controls ---- __NOEDITSECTION__ __NOTOC__ The behaviour of the ABF method is controll...") |
No edit summary |
||
(10 intermediate revisions by one other user not shown) | |||
Line 2: | Line 2: | ||
---- | ---- | ||
__NOEDITSECTION__ __NOTOC__ | __NOEDITSECTION__ __NOTOC__ | ||
The | The behavior of the ABF method is controlled by the setup provided in the [abf] and eventually [abf-walker] sections. Both sections belong to the {PMFLIB} group. | ||
==[abf]== | ==[abf]== | ||
Line 14: | Line 14: | ||
| 0 | | 0 | ||
| [[Control key types|integer]] | | [[Control key types|integer]] | ||
| The mode of the ABF method:<br/>0 - the method is disabled<br/> 1 - the standard ABF implementation is used<br/> 2 - less accurate | | The mode of the ABF method:<br/>0 - the method is disabled<br/> 1 - the standard ABF implementation is used (four points)<br/> 2 - less accurate implementation is used (two points)<br/>If the method is enabled then at least one collective variable must be provided in the {ABF} group. The collective variable specification is described in [[ABF:Collective variables]]. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| | | fapply_abf | ||
| | | on | ||
| [[Control key types|logical]] | | [[Control key types|logical]] | ||
| | | Determine if the collected mean force is applied as a bias. | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| feimode | | feimode | ||
| 1 | | 1 | ||
| [[Control key types|integer]] | | [[Control key types|integer]] | ||
| The extrapolation/interpolation mode for ABF forces:<br/> | | The extrapolation/interpolation mode for ABF forces:<br/>0 - disabled<br/>1 - linear ramp with bottom limit<br/>2 - Gaussian kernel smoothing<br/>This option triggers further setup, which is optional and described below. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| fsample | | fsample | ||
| | | 5000 | ||
| [[Control key types|integer]] | | [[Control key types|integer]] | ||
| Every <i>fsample</i> MD steps, the actual information about collective variable values will be printed to the ABF output file. The name of the output file is provided in the [[General setup|[files]]] section. | | Every <i>fsample</i> MD steps, the actual information about collective variable values will be printed to the ABF output file. The name of the output file is provided in the [[General setup|[files]]] section. | ||
Line 34: | Line 34: | ||
| off | | off | ||
| [[Control key types|logical]] | | [[Control key types|logical]] | ||
| Disable/Enable restarting the ABF simulation from the previous run. The name of the restart file is provided in the [[General setup|[files]]] section. If the restart is enabled but no restart file exists | | Disable/Enable restarting the ABF simulation from the previous run. The name of the restart file is provided in the [[General setup|[files]]] section. If the restart is enabled but no restart file exists, then warning is raised and the simulation continues. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| frstupdate | | frstupdate | ||
| | | 5000 | ||
| [[Control key types|integer]] | | [[Control key types|integer]] | ||
| Every <i>frstupdate</i> MD steps, the actual ABF force and other data will be printed to the ABF restart file. The name of the restart file is provided in the [[General setup|[files]]] section. | | Every <i>frstupdate</i> MD steps, the actual ABF force and other data will be printed to the ABF restart file. The name of the restart file is provided in the [[General setup|[files]]] section. | ||
Line 45: | Line 45: | ||
| [[Control key types|integer]] | | [[Control key types|integer]] | ||
| Every <i>ftrjsample</i> MD steps, the actual ABF acumulator and other data will be printed to the ABF trajectory file. The name of the trajectory file is provided in the [[General setup|[files]]] section. Zero interval disables the ABF trajectory writing. | | Every <i>ftrjsample</i> MD steps, the actual ABF acumulator and other data will be printed to the ABF trajectory file. The name of the trajectory file is provided in the [[General setup|[files]]] section. Zero interval disables the ABF trajectory writing. | ||
|- style="vertical-align: top;" | |||
| fapply_mask | |||
| off | |||
| [[Control key types|logical]] | |||
| Disable/Enable ABF force weights (mask). The name of file with the ABF weights is provided in the [[General setup|[files]]] section. The ABF mask is suitable for difficult free energy surfaces containing high energy regions, which is not necessary/appropriate to sample. | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fenthalpy | |||
| off | |||
| [[Control key types|logical]] | |||
| If enabled, data for enthalpy calculation are collected. | |||
|- style="vertical-align: top;" | |||
| fentropy | |||
| off | |||
| [[Control key types|logical]] | |||
| If enabled, data for entropy (-TdS) calculation are collected. | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fepotoffset | |||
| 0.0 | |||
| [[Control key types|real]] | |||
| A constant, which is added to the potential energy (affect the enthalpy calculation). | |||
|- style="vertical-align: top;" | |||
| fekinoffset | |||
| 0.0 | |||
| [[Control key types|real]] | |||
| A constant, which is added to the kinetic energy (affect the entropy calculation). | |||
|} | |} | ||
If the feimode option is equal to 1 then following | ===Linear ramp=== | ||
If the feimode option is equal to 1 then the following options change behavior of the linear ramp. | |||
{| style="width: 100%;" | {| style="width: 100%;" | ||
| style="width: 10em;" | '''Key''' | | style="width: 10em;" | '''Key''' | ||
Line 54: | Line 80: | ||
| '''Description''' | | '''Description''' | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| | | fhramp_min | ||
| 100 | | 100 | ||
| [[Control key types|integer]] | | [[Control key types|integer]] | ||
| Top limit for number of samples in a bin. If the actual number of samples in a bin is higher than this number then estimated ABF force is | | Bottom limit for number of samples in a bin. If the actual number of samples in a bin is lower than this number no ABF force is applied. | ||
|- style="vertical-align: top;" | |||
| fhramp_max | |||
| 200 | |||
| [[Control key types|integer]] | |||
| Top limit for number of samples in a bin. If the actual number of samples in a bin is higher than this number then estimated ABF force is applied fully otherwise it is scaled down by the linear ramp. | |||
|} | |} | ||
The linear ramp has following form: | The linear ramp has the following form: | ||
<center><math>\bold F_{ | <center><math>\bold F_{applied} = \frac{N_k - fhramp\_min}{fhramp\_max-fhramp\_min}\bold F_{estimated}</math>, if <math>N_k < fhramp\_max</math>,</center> | ||
otherwise the full force is applied: | |||
If the feimode option is equal to 2 then following option changes | <center><math>\bold F_{applied} = \bold F_{estimated}</math>,</center> | ||
where <math>N_k</math> is the number of samples in the bin <i>k</i>. | |||
===Gaussian kernel smoothing=== | |||
If the feimode option is equal to 2 then the following option changes behavior of the Gaussian kernel smoothing. This filter requires an additional parameter (wfac) specified for each CV. | |||
{| style="width: 100%;" | {| style="width: 100%;" | ||
| style="width: 10em;" | '''Key''' | | style="width: 10em;" | '''Key''' | ||
Line 69: | Line 104: | ||
| '''Description''' | | '''Description''' | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| | | fsmoothupdate | ||
| | | 5000 | ||
| [[Control key types|integer]] | | [[Control key types|integer]] | ||
| | | The value determines how often (in MD steps) the smoothed mean forces are updated. | ||
|} | |} | ||
The | The relationships between the sampled instantaneous collective and smoothed forces is given: | ||
<center><math>\bold F_{aplied} = \frac{ | <center><math>\bold F_{aplied}(\boldsymbol \xi_i) = \frac{ \sum\limits_{j=1}^{N_{bins}} K(\boldsymbol \xi_i,\boldsymbol \xi_j)\bold F_{estimated}(\boldsymbol \xi_j)} {\sum\limits_{j=1}^{N_{bins}} K(\boldsymbol \xi_i,\boldsymbol \xi_j) }</math></center>, | ||
with the Gaussian smoothing kernel defined as: | |||
<center><math>K(\boldsymbol \xi_i,\boldsymbol \xi_j) = exp\left( - \frac {1}{2} \sum\limits_{k=1}^{N_{CVS}} \frac { (\xi_{i,k} - \xi_{j,k})^2} { w_{k}^2 h_{k}^2 } \right)</math></center>, | |||
where <math>h_{k}^2</math> is a bin width and <math>w_{k}^2</math> is an user provided factor (wfac), see [[ABF:Collective variables]]. | |||
==[abf-walker]== | ==[abf-walker]== | ||
The optional section [abf-walker] provides information about access to the MWA server. The MWA extension is described in [[ABF:Multiple walkers approach]]. | |||
{| style="width: 100%;" | {| style="width: 100%;" | ||
| style="width: 10em;" | '''Key''' | | style="width: 10em;" | '''Key''' | ||
Line 95: | Line 126: | ||
| | | | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| The name of file with a server key. The server key contains information about the server name, the port number and the server password. The file is generated by the | | The name of a file with a server key. The server key contains information about the server name, the port number, and the server password. The file is generated by the mwa-server utility when the MWA server is started. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| fserverupdate | | fserverupdate | ||
| | | 20000 | ||
| [[Control key types|integer]] | | [[Control key types|integer]] | ||
| The number of MD steps between exchanges of data with the MWA server. Since data are exchanged in a connect/send/receive/disconnect mode, exchanges should not occur too often | | The number of MD steps between exchanges of data with the MWA server. Since data are exchanged in a connect/send/receive/disconnect mode, exchanges should not occur too often. | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| fabortonmwaerr | |||
| on | |||
| [[Control key types|logical]] | |||
| Should the running of a walker (client) abort when MWA server communication failure occurs? | |||
|- style="vertical-align: top" | |||
| fconrepeats | | fconrepeats | ||
| 0 | | 0 |
Latest revision as of 11:20, 2 August 2021
Navigation: Documentation / Methods / Adaptive Biasing Force Method / ABF:Controls
The behavior of the ABF method is controlled by the setup provided in the [abf] and eventually [abf-walker] sections. Both sections belong to the {PMFLIB} group.
[abf]
Key | Default value | Type | Description |
fmode | 0 | integer | The mode of the ABF method: 0 - the method is disabled 1 - the standard ABF implementation is used (four points) 2 - less accurate implementation is used (two points) If the method is enabled then at least one collective variable must be provided in the {ABF} group. The collective variable specification is described in ABF:Collective variables. |
fapply_abf | on | logical | Determine if the collected mean force is applied as a bias. |
feimode | 1 | integer | The extrapolation/interpolation mode for ABF forces: 0 - disabled 1 - linear ramp with bottom limit 2 - Gaussian kernel smoothing This option triggers further setup, which is optional and described below. |
fsample | 5000 | integer | Every fsample MD steps, the actual information about collective variable values will be printed to the ABF output file. The name of the output file is provided in the [files] section. |
frestart | off | logical | Disable/Enable restarting the ABF simulation from the previous run. The name of the restart file is provided in the [files] section. If the restart is enabled but no restart file exists, then warning is raised and the simulation continues. |
frstupdate | 5000 | integer | Every frstupdate MD steps, the actual ABF force and other data will be printed to the ABF restart file. The name of the restart file is provided in the [files] section. |
ftrjsample | 0 | integer | Every ftrjsample MD steps, the actual ABF acumulator and other data will be printed to the ABF trajectory file. The name of the trajectory file is provided in the [files] section. Zero interval disables the ABF trajectory writing. |
fapply_mask | off | logical | Disable/Enable ABF force weights (mask). The name of file with the ABF weights is provided in the [files] section. The ABF mask is suitable for difficult free energy surfaces containing high energy regions, which is not necessary/appropriate to sample. |
fenthalpy | off | logical | If enabled, data for enthalpy calculation are collected. |
fentropy | off | logical | If enabled, data for entropy (-TdS) calculation are collected. |
fepotoffset | 0.0 | real | A constant, which is added to the potential energy (affect the enthalpy calculation). |
fekinoffset | 0.0 | real | A constant, which is added to the kinetic energy (affect the entropy calculation). |
Linear ramp
If the feimode option is equal to 1 then the following options change behavior of the linear ramp.
Key | Default value | Type | Description |
fhramp_min | 100 | integer | Bottom limit for number of samples in a bin. If the actual number of samples in a bin is lower than this number no ABF force is applied. |
fhramp_max | 200 | integer | Top limit for number of samples in a bin. If the actual number of samples in a bin is higher than this number then estimated ABF force is applied fully otherwise it is scaled down by the linear ramp. |
The linear ramp has the following form:
otherwise the full force is applied:
where is the number of samples in the bin k.
Gaussian kernel smoothing
If the feimode option is equal to 2 then the following option changes behavior of the Gaussian kernel smoothing. This filter requires an additional parameter (wfac) specified for each CV.
Key | Default value | Type | Description |
fsmoothupdate | 5000 | integer | The value determines how often (in MD steps) the smoothed mean forces are updated. |
The relationships between the sampled instantaneous collective and smoothed forces is given:
,
with the Gaussian smoothing kernel defined as:
,
where is a bin width and is an user provided factor (wfac), see ABF:Collective variables.
[abf-walker]
The optional section [abf-walker] provides information about access to the MWA server. The MWA extension is described in ABF:Multiple walkers approach.
Key | Default value | Type | Description |
fserverkey | string | The name of a file with a server key. The server key contains information about the server name, the port number, and the server password. The file is generated by the mwa-server utility when the MWA server is started. | |
fserverupdate | 20000 | integer | The number of MD steps between exchanges of data with the MWA server. Since data are exchanged in a connect/send/receive/disconnect mode, exchanges should not occur too often. |
fabortonmwaerr | on | logical | Should the running of a walker (client) abort when MWA server communication failure occurs? |
fconrepeats | 0 | integer | The number of consecutive failed exchanges with the server that will lead to premature client termination. The zero means that no failures are allowed and the client is terminated at the first failed exchange. |