General setup: Difference between revisions
Jump to navigation
Jump to search
Created page with "Navigation: Documentation / Control file / General setup ---- General setup of PMFLib can be controlled by following sections specified in the {PMFLIB} group. They..." |
No edit summary |
||
| Line 79: | Line 79: | ||
| '''Description''' | | '''Description''' | ||
|- | |- | ||
| | | colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''Collective Variables''' | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fcvsdef | |||
| {CVS} | |||
| [[Control key types|string]] | |||
| | |||
|- style="vertical-align: top;" | |||
| fpathsdef | |||
| {PATHS} | |||
| [[Control key types|string]] | |||
| | |||
|- | |||
| colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''[[Adaptive Biasing Force Method]]''' | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| fabfdef | | fabfdef | ||
| Line 86: | Line 98: | ||
| It defines either a PRMFile group or a file name containing the specification of collective variables used by the ABF method. | | It defines either a PRMFile group or a file name containing the specification of collective variables used by the ABF method. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| fabfmask | |||
| _abf.mask | |||
| [[Control key types|string]] | |||
| It defines the name of the file that contains ABF force weights. | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fabfout | | fabfout | ||
| _abf.out | | _abf.out | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines | | It defines the file name used as output from ABF method simulations. This file contains status information and the progress of collective variables in time. | ||
|- style="vertical-align: top | |- style="vertical-align: top;" | ||
| fabfrst | | fabfrst | ||
| _abf.rst | | _abf.rst | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines the name of file with accumulated results from ABF simulations. | | It defines the name of the file with accumulated results from ABF simulations. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| fabftrj | | fabftrj | ||
| _abf.trj | | _abf.trj | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines the name of file | | It defines the name of the file containing the time evolution of accumulated ABF results. | ||
|- | |||
| colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''[[Adaptive Biasing Potential Method]]''' | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fabpdef | |||
| {ABP} | |||
| [[Control key types|string]] | |||
| | |||
|- style="vertical-align: top;" | |||
| fabpout | |||
| _abp.out | |||
| [[Control key types|string]] | |||
| | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| | | fabprst | ||
| | | _abp.rst | ||
| [[Control key types|string]] | |||
| | |||
|- style="vertical-align: top;" | |||
| fabptrj | |||
| _abp.trj | |||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| | | | ||
|- | |- | ||
| | | colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''[[Constrained Dynamics]]''' | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| | | fcstdef | ||
| { | | {CST} | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines either a PRMFile group or a file name containing the specification of constraints. | | It defines either a PRMFile group or a file name containing the specification of constraints. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| | | fcstout | ||
| | | _cst.out | ||
| [[Control key types|string]] | |||
| It defines the file name used as output from constrained dynamics simulations. This file contains status information and the progress of the calculation in time. | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fcstdump | |||
| _cst.dump | |||
| [[Control key types|string]] | |||
| | |||
|- style="vertical-align: top;" | |||
| fcstrst | |||
| _cst.rst | |||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines | | It defines the name of the file with results from the constrained dynamics simulation. This file is used for constrained dynamics calculation restarts. | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| | | fcstctr | ||
| | | | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| | | | ||
|- style="vertical-align: top;" | |||
| fcsttrj | |||
| _cst.trj | |||
| [[Control key types|string]] | |||
| | |||
|- | |- | ||
| | | colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''[[Metadynamics]]''' | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| fmtddef | | fmtddef | ||
| Line 133: | Line 182: | ||
| _mtd.out | | _mtd.out | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines | | It defines the file name used as output from the metadynamics method. This file contains status information and the progress of collective coordinates in time. | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| fmtdrst | | fmtdrst | ||
| _mtd.rst | | _mtd.rst | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines the name of file | | It defines the name of the file containing accumulated Gaussian hills from metadynamics simulations. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| | | fmtdtrj | ||
| _mtd. | | _mtd.trj | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| | | | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| fmtdhills | | fmtdhills | ||
| _mtd.hills | | _mtd.hills | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines the name of file | | It defines the name of the file containing accumulated Gaussian hills from metadynamics simulations. | ||
|- | |- | ||
| | | colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''[[Restrained Dynamics]]''' | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| | | frstdef | ||
| {RST} | | {RST} | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines either a PRMFile group or a file name containing the specification of restraints used in restrained dynamics simulations. | | It defines either a PRMFile group or a file name containing the specification of restraints used in restrained dynamics simulations. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
| | | frstout | ||
| _rst.out | | _rst.out | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines | | It defines the file name used as output from restrained dynamics simulations. This file contains status information and the progress of restrained collective variables in time. | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| | | frsthist | ||
| _rst. | | _rst.hist | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines the name of file | | It defines the name of the file containing the run-time histogram of collective variables. | ||
|- | |- | ||
| colspan=" | | colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''[[String Method]]''' | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| fstmdef | | fstmdef | ||
| Line 177: | Line 226: | ||
| _stm.out | | _stm.out | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines | | It defines the file name used as output from string method simulations. | ||
|- | |||
| colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''MTC Method''' | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fmtcdef | |||
| {MTC} | |||
| [[Control key types|string]] | |||
| | |||
|- style="vertical-align: top;" | |||
| fmtcout | |||
| _mtc.out | |||
| [[Control key types|string]] | |||
| | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fmtcrst | |||
| _mtc.rst | |||
| [[Control key types|string]] | |||
| | |||
|- | |- | ||
| colspan=" | | colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''[[Collective Variable Monitoring]]''' | ||
|- style="vertical-align: top; background-color: #f6f6f6;" | |- style="vertical-align: top; background-color: #f6f6f6;" | ||
| fmondef | | fmondef | ||
| Line 189: | Line 255: | ||
| _mon.out | | _mon.out | ||
| [[Control key types|string]] | | [[Control key types|string]] | ||
| It defines | | It defines the file name used as output from collective variable monitoring. | ||
|- | |||
| colspan="4" style="text-align: center; background-color: #CCCCFF;" | '''Path Driving''' | |||
|- style="vertical-align: top; background-color: #f6f6f6;" | |||
| fpdrvdef | |||
| {PDRV} | |||
| [[Control key types|string]] | |||
| | |||
|- style="vertical-align: top;" | |||
| fpdrvout | |||
| _pdrv.out | |||
| [[Control key types|string]] | |||
| | |||
|} | |} | ||
Revision as of 20:31, 2 June 2026
Navigation: Documentation / Control file / General setup
General setup of PMFLib can be controlled by following sections specified in the {PMFLIB} group. They control behaviour of PMFLib core, define units used for input data specification and names of input and output files.
[control]
| Key | Default value | Type | Description |
| ftopology | system topology | string | The name of file with a system topology in AMBER7 format. If provided the loaded topology will be used during ASL masks processing instead of the system topology. |
| fdebug | off | logical | If enabled it prints debugging information if they are available. |
| fprint_masks | off | logical | If enabled it prints detailed information about atoms in each ASL masks. |
| fprint_inpcrds | off | logical | If enabled it prints input coordinates inluding atom and residues names and indexes. |
| fenable_pbc | off | logical | If enabled then the periodic boundary conditions are used whenever possible. Please note that not all collective variables are influenced by this option. |
[units]
| Key | Default value | Type | Description |
| mass | g/mol | string | unit of molar mass Allowed values are : g/mol |
| time | fs | string | unit of time Allowed values are : fs |
| length | A | string | unit of length Allowed values are : A |
| angle | rad | string | unit of angle Allowed values are : deg, rad |
| energy | kcal/mol | string | unit of energy Allowed values are : kcal/mol |
Units provided here are used only for input parameters and for output data printed into output files. Other data printed into restarts or other internal files still use internal units.
[files]
| Key | Default value | Type | Description |
| Collective Variables | |||
| fcvsdef | {CVS} | string | |
| fpathsdef | {PATHS} | string | |
| Adaptive Biasing Force Method | |||
| fabfdef | {ABF} | string | It defines either a PRMFile group or a file name containing the specification of collective variables used by the ABF method. |
| fabfmask | _abf.mask | string | It defines the name of the file that contains ABF force weights. |
| fabfout | _abf.out | string | It defines the file name used as output from ABF method simulations. This file contains status information and the progress of collective variables in time. |
| fabfrst | _abf.rst | string | It defines the name of the file with accumulated results from ABF simulations. |
| fabftrj | _abf.trj | string | It defines the name of the file containing the time evolution of accumulated ABF results. |
| Adaptive Biasing Potential Method | |||
| fabpdef | {ABP} | string | |
| fabpout | _abp.out | string | |
| fabprst | _abp.rst | string | |
| fabptrj | _abp.trj | string | |
| Constrained Dynamics | |||
| fcstdef | {CST} | string | It defines either a PRMFile group or a file name containing the specification of constraints. |
| fcstout | _cst.out | string | It defines the file name used as output from constrained dynamics simulations. This file contains status information and the progress of the calculation in time. |
| fcstdump | _cst.dump | string | |
| fcstrst | _cst.rst | string | It defines the name of the file with results from the constrained dynamics simulation. This file is used for constrained dynamics calculation restarts. |
| fcstctr | string | ||
| fcsttrj | _cst.trj | string | |
| Metadynamics | |||
| fmtddef | {MTD} | string | It defines either a PRMFile group or a file name containing the specification of metadynamics collective variables. |
| fmtdout | _mtd.out | string | It defines the file name used as output from the metadynamics method. This file contains status information and the progress of collective coordinates in time. |
| fmtdrst | _mtd.rst | string | It defines the name of the file containing accumulated Gaussian hills from metadynamics simulations. |
| fmtdtrj | _mtd.trj | string | |
| fmtdhills | _mtd.hills | string | It defines the name of the file containing accumulated Gaussian hills from metadynamics simulations. |
| Restrained Dynamics | |||
| frstdef | {RST} | string | It defines either a PRMFile group or a file name containing the specification of restraints used in restrained dynamics simulations. |
| frstout | _rst.out | string | It defines the file name used as output from restrained dynamics simulations. This file contains status information and the progress of restrained collective variables in time. |
| frsthist | _rst.hist | string | It defines the name of the file containing the run-time histogram of collective variables. |
| String Method | |||
| fstmdef | {STM} | string | It defines either a PRMFile group or a file name containing the specification of collective variables used by the string method. |
| fstmout | _stm.out | string | It defines the file name used as output from string method simulations. |
| MTC Method | |||
| fmtcdef | {MTC} | string | |
| fmtcout | _mtc.out | string | |
| fmtcrst | _mtc.rst | string | |
| Collective Variable Monitoring | |||
| fmondef | {MON} | string | It defines either a PRMFile group or a file name containing the specification of collective variables used during monitoring. |
| fmonout | _mon.out | string | It defines the file name used as output from collective variable monitoring. |
| Path Driving | |||
| fpdrvdef | {PDRV} | string | |
| fpdrvout | _pdrv.out | string | |