From fe436f7486217a694e128aeeb746902f05274428 Mon Sep 17 00:00:00 2001 From: Mark Abraham Date: Fri, 5 Feb 2016 18:40:28 +0100 Subject: [PATCH] Clarify use of tau-p and pcoupltype grompp used to permit "tau-p = 5 5" which is misleading. The recent fix for #1893 leads to the user receiving a grompp warning, so this improves the docs to make clear that pressure coupling is not implemented like temperature coupling (where different time constants might be used). Refs #1893 Change-Id: I8328b30a12689795c7af2d12dfc94db11b78a03a --- docs/user-guide/mdp-options.rst | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/user-guide/mdp-options.rst b/docs/user-guide/mdp-options.rst index f379005829..237cd72c55 100644 --- a/docs/user-guide/mdp-options.rst +++ b/docs/user-guide/mdp-options.rst @@ -1181,19 +1181,23 @@ Pressure coupling .. mdp:: pcoupltype + Specifies the kind of isotropy of the pressure coupling used. Each + kind takes one or more values for :mdp:`compressibility` and + :mdp:`ref-p`. Only a single value is permitted for :mdp:`tau-p`. + .. mdp-value:: isotropic Isotropic pressure coupling with time constant - :mdp:`tau-p`. The compressibility and reference pressure are - set with :mdp:`compressibility` and :mdp:`ref-p`, one value is - needed. + :mdp:`tau-p`. One value each for :mdp:`compressibility` and + :mdp:`ref-p` is required. .. mdp-value:: semiisotropic Pressure coupling which is isotropic in the ``x`` and ``y`` direction, but different in the ``z`` direction. This can be - useful for membrane simulations. 2 values are needed for ``x/y`` - and ``z`` directions respectively. + useful for membrane simulations. Two values each for + :mdp:`compressibility` and :mdp:`ref-p` are required, for + ``x/y`` and ``z`` directions respectively. .. mdp-value:: anisotropic @@ -1229,18 +1233,21 @@ Pressure coupling .. mdp:: tau-p (1) \[ps\] - time constant for coupling + The time constant for pressure coupling (one value for all + directions). .. mdp:: compressibility \[bar^-1\] - compressibility (NOTE: this is now really in bar-1) For water at 1 - atm and 300 K the compressibility is 4.5e-5 bar^-1. + The compressibility (NOTE: this is now really in bar^-1) For water at 1 + atm and 300 K the compressibility is 4.5e-5 bar^-1. The number of + required values is implied by :mdp:`pcoupltype`. .. mdp:: ref-p \[bar\] - reference pressure for coupling + The reference pressure for coupling. The number of required values + is implied by :mdp:`pcoupltype`. .. mdp:: refcoord-scaling -- 2.11.4.GIT