Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update doc and comment for ethresh in pme #185

Merged
merged 1 commit into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions dmff/admp/pme.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def __init__(
rc:
float: cutoff distance
ethresh:
float: pme energy threshold
float: (empirical) average relative error in the PME forces
lmax:
int: max L for multipoles
lpol:
Expand Down Expand Up @@ -441,7 +441,7 @@ def setup_ewald_parameters(
rc: float
The cutoff distance, in nm
ethresh: float
Required energy precision, in kJ/mol
(Empirical) average relative error in the PME forces
box: ndarray, optional
3*3 matrix, box size, a, b, c arranged in rows, used in openmm method
spacing: float, optional
Expand Down
4 changes: 2 additions & 2 deletions docs/admp/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ In `run.py`, when creating the potential function, several key parameters are no
```python
potentials = H.createPotential(pdb.topology, nonbondedCutoff=rc*angstrom, nonbondedMethod=CutoffPeriodic, ethresh=1e-4)
```
* `ethresh`: this is the energy threshold for PME
* `ethresh`: the (empirical) average relative error in the PME forces, which is used to setup the size of the meshgrid of PME (see [openmm doc](http://docs.openmm.org/latest/userguide/theory/02_standard_forces.html#coulomb-interaction-with-particle-mesh-ewald) for more details).
* `rc`: the cutoff distance. `rc`, `ethresh`, and `box` together, determine the $K_{max}$ and $\kappa$
(please see [theory](../user_guide/theory.md)).
Note that the `rc` variable in here is only used to determine the PME settings. The user has to make sure the `rc`
Expand Down Expand Up @@ -161,7 +161,7 @@ LastAxisTypeIndex = 6

* `rc`: cutoff distance in real space. Only used to determine the PME settings.

* `ethresh`: energy threshold for PME.
* `ethresh`: (empirical) average relative error in the PME forces, which is used to setup the size of the meshgrid of PME (see [openmm doc](http://docs.openmm.org/latest/userguide/theory/02_standard_forces.html#coulomb-interaction-with-particle-mesh-ewald) for more details).

* `lmax`: max L for multipoles.

Expand Down
5 changes: 2 additions & 3 deletions docs/user_guide/4.2ADMPPmeForce.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ A few keywords in `createPotential` would impact the behavior of the function:
settings.POL_COV = 2.0
```

* `ethresh`: the accuracy of PME, used to setup the size of the meshgrid of PME.
* `ethresh`: the (empirical) average relative error in the PME forces, which is used to setup the size of the meshgrid of PME (see [openmm doc](http://docs.openmm.org/latest/userguide/theory/02_standard_forces.html#coulomb-interaction-with-particle-mesh-ewald) for more details).

A typical `xml` file to define an ADMPDispPmeForce frontend is:

Expand Down Expand Up @@ -255,8 +255,7 @@ generator_pme = H.getGenerators()[0] # if ADMPDispPmeForce is the First force no
```
The keyword `ethresh` in `createPotential` would impact the behavior of the function:

* `ethresh`: the accuracy of PME, used to setup the size of the meshgrid of PME.

* `ethresh`: the (empirical) average relative error in the PME forces, which is used to setup the size of the meshgrid of PME (see [openmm doc](http://docs.openmm.org/latest/userguide/theory/02_standard_forces.html#coulomb-interaction-with-particle-mesh-ewald) for more details).


## 3. ADMPPmeGenerator Doc
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/4.3ADMPQeqForce.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ A few keywords in `createPotential` would impact the behavior of the function:
* `const_list`: the atomic numbers of all residues with different constraints.
* `const_vals`: the corresponding constraint valu on each residue.

* `ethresh`: the accuracy of PME, used to setup the size of the meshgrid of PME.
* `ethresh`: the (empirical) average relative error in the PME forces, which is used to setup the size of the meshgrid of PME (see [openmm doc](http://docs.openmm.org/latest/userguide/theory/02_standard_forces.html#coulomb-interaction-with-particle-mesh-ewald) for more details).
* `has_aux`: bool type, whether to intruduce auxilliary parameters, equilibrated atomic charges, etc.

## 3. ADMPQeqGenerator Doc
Expand Down
Loading