Skip to content

Commit 09d0258

Browse files
committed
renamed "oplsaa.lt"-->"oplsaa2023.lt" and updated the examples and documentation. The existing "oplsaa.lt" file (and its associated files) still exists. But when users import "oplsaa.lt", moltemplate will create a file named "WARNING_PLEASE_USE_oplsaa2023.lt_INSTEAD.TXT", warning them that "oplsaa.lt" will be deleted in the near future.
1 parent 43b9c79 commit 09d0258

File tree

85 files changed

+11408
-246
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+11408
-246
lines changed

doc/moltemplate_manual_src/moltemplate_manual.tex

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2613,7 +2613,7 @@ \subsection{Bonded interactions \textit{by type}}
26132613
commands,
26142614
as well as force field parameters and related atom type properties.
26152615
It's also a good idea to store force-field objects in a separate file
2616-
(eg ``forcefield.lt'', ``oplsaa.lt'', ``gaff2.lt'', ``compass.lt'', etc...)
2616+
(eg ``forcefield.lt'', ``oplsaa2023.lt'', ``gaff2.lt'', ``compass.lt'', etc...)
26172617
so that these rules and parameters can be be applied to different molecules
26182618
more easily (by using the \textit{import} command to load the file when needed).
26192619

@@ -2905,7 +2905,7 @@ \subsection{``In Charges''}
29052905
%Some force fields (such as the current implementation of OPLSAA and LOPLSAA)
29062906
%assign atom charge according to atom type.
29072907
For example, here is an excerpt
2908-
from the ``loplsaa.lt'' file (on 2020-8-09):
2908+
from the ``loplsaa2023.lt'' file (on 2020-8-09):
29092909
\begin{verbatim}
29102910
write_once("In Charges") {
29112911
set type @atom:80L charge -0.222 # "Alkane CH3- (LOPLS)"
@@ -2983,7 +2983,7 @@ \subsection{``Data Charge By Bond''}
29832983

29842984
\subsection{The \textit{force\_fields} directory}
29852985
\label{sec:moltemplate_path}
2986-
Files containing popular force fields (like ``oplsaa.lt'' and ``gaff2.lt'')
2986+
Files containing popular force fields (like ``oplsaa2023.lt'' and ``gaff2.lt'')
29872987
and molecule models (like ``spce.lt'') are stored in the ``force\_fields/''
29882988
subdirectory distributed with moltemplate. (This directory is included when
29892989
you download moltemplate using either git or pip.)
@@ -3088,7 +3088,7 @@ \subsection{Extending an existing force field}
30883088
\end{verbatim}
30893089

30903090
Incidentally, this is how the LOPLS force field was implemented.
3091-
See \href{https://github.com/jewettaij/moltemplate/blob/master/moltemplate/force_fields/loplsaa.lt}{\tt loplsaa.lt}.
3091+
See \href{https://github.com/jewettaij/moltemplate/blob/master/moltemplate/force_fields/loplsaa2023.lt}{\tt loplsaa2023.lt}.
30923092

30933093

30943094
\textit{
@@ -4632,7 +4632,7 @@ \subsubsection{Multiple inheritance:}
46324632
\textit{multiple} different force-field parents:
46334633
\begin{verbatim}
46344634
import "trappe1998.lt"
4635-
import "oplsaa.lt"
4635+
import "oplsaa2023.lt"
46364636
46374637
Butane inherits TraPPE OPLSAA {
46384638
...

examples/all_atom/force_field_AMBER/benzene/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Benzene inherits GAFF { ... } # (see "benzene.lt")
2222

2323
### *WARNING: The atomic charges in this examples are not correct*
2424

25-
The AMBER for field does not include charge information. (In this example, they were borrowed from the corresponding atoms in the ["oplsaa.lt" file](../../../../moltemplate/force_fields/oplsaa.lt). Do not do this!)
25+
The AMBER for field does not include charge information. (In this example, they were borrowed from the corresponding atoms in the ["oplsaa2023.lt" file](../../../../moltemplate/force_fields/oplsaa2023.lt). Do not do this!)
2626

2727
The generation of atomic partial charges requires 3rd party software.
2828

examples/all_atom/force_field_AMBER/ethylene+benzene/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The number of molecules, positions, and simulation box size can be controlled by
1212

1313
### *WARNING: The atomic charges in this examples are not correct*
1414

15-
The AMBER for field does not include charge information. (In this example, they were borrowed from the corresponding atoms in the ["oplsaa.lt" file](../../../../moltemplate/force_fields/oplsaa.lt). Do not do this!)
15+
The AMBER for field does not include charge information. (In this example, they were borrowed from the corresponding atoms in the ["oplsaa2023.lt" file](../../../../moltemplate/force_fields/oplsaa2023.lt). Do not do this!)
1616

1717
The generation of atomic partial charges requires 3rd party software.
1818

examples/all_atom/force_field_AMBER/hexadecane/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The number of molecules and simulation box size can be controlled by editing the
1111

1212
### *WARNING: The atomic charges in this examples are not correct*
1313

14-
The AMBER for field does not include charge information. (In this example, they were borrowed from the corresponding atoms in the ["oplsaa.lt" file](../../../../moltemplate/force_fields/oplsaa.lt). Do not do this!)
14+
The AMBER for field does not include charge information. (In this example, they were borrowed from the corresponding atoms in the ["oplsaa2023.lt" file](../../../../moltemplate/force_fields/oplsaa2023.lt). Do not do this!)
1515

1616
The generation of atomic partial charges requires 3rd party software.
1717

examples/all_atom/force_field_AMBER/waterTIP3P+isobutane/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The number of molecules, positions, and simulation box size can be controlled by
1818

1919
### *WARNING: The atomic charges in this examples are not correct*
2020

21-
The AMBER for field does not include charge information. (In this example, they were borrowed from the corresponding atoms in the ["oplsaa.lt" file](../../../../moltemplate/force_fields/oplsaa.lt). Do not do this!)
21+
The AMBER for field does not include charge information. (In this example, they were borrowed from the corresponding atoms in the ["oplsaa2023.lt" file](../../../../moltemplate/force_fields/oplsaa2023.lt). Do not do this!)
2222

2323
The generation of atomic partial charges requires 3rd party software.
2424

examples/all_atom/force_field_OPLSAA/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ There is no guarantee that simulations prepared using moltemplate will reproduce
66

77

88

9-
### Suggestion: Make a local copy of the "oplsaa.lt" file
9+
### Suggestion: Make a local copy of the "oplsaa2023.lt" file
1010

1111
WARNING: The OPLSAA force field changes slightly over time.
1212
When it happens, it can cause the names of the
1313
@atoms, @bonds, @angles, and @dihedrals types to change.
1414
This could break backward compatibility,
1515
and cause moltemplate.sh to fail when reading your .lt files.
1616
So if you are using OPLSAA, it's a good idea to make a backup copy of the
17-
[oplsaa.lt file](../../../moltemplate/force_fields/oplsaa.lt)
17+
[oplsaa2023.lt file](../../../moltemplate/force_fields/oplsaa2023.lt)
1818
(located in the
1919
[moltemplate/force_fields/](../../../moltemplate/force_fields/) folder).
20-
Copy it to the folder with your other .lt files for the simulation you are working on. (Moltemplate will look in the local folder first for all the .lt files that it needs, including "oplsaa.lt".)
20+
Copy it to the folder with your other .lt files for the simulation you are working on. (Moltemplate will look in the local folder first for all the .lt files that it needs, including "oplsaa2023.lt".)
2121
This will protect you from force-field parameter changes, and you
2222
will be able to continue using your existing atom and bonded type names safely.
2323

@@ -29,7 +29,7 @@ will be able to continue using your existing atom and bonded type names safely.
2929
In most of the OPLSAA examples,
3030
the atomic charges are determined by their @atom types
3131
*(...according to a lookup table located at the beginning of the
32-
["oplsaa.lt"](../../../moltemplate/force_fields/oplsaa.lt) file)*.
32+
["oplsaa2023.lt"](../../../moltemplate/force_fields/oplsaa2023.lt) file)*.
3333
*(Any atomic charges listed in the "Data Atoms" section of your molecule's
3434
LT files will be ignored.)*
3535
**These charges can be overridden.**
@@ -49,7 +49,7 @@ moltemplate.sh, and later read by LAMMPS.)*
4949
2) **Specify charges using "set" commands.**
5050
*(This is how the OPLSAA atom charges are specified.
5151
After running moltemplate, atom charge information in the
52-
["oplsaa.lt" file](../../../moltemplate/force_fields/oplsaa.lt)
52+
["oplsaa2023.lt" file](../../../moltemplate/force_fields/oplsaa2023.lt)
5353
is copied into the "system.in.charges" file created by moltemplate.sh.
5454
A LAMMPS input script file (eg. "run.in.nvt" or "run.in.npt")
5555
is included with all of the OPLSAA examples. It tells LAMMPS to read
@@ -58,15 +58,15 @@ This overrides the atom charges from the "system.data" file.)*
5858

5959

6060
#### How to customize atomic charge
61-
*(without modifying "oplsaa.lt")*
61+
*(without modifying "oplsaa2023.lt")*
6262

6363
1) If you use use a 3rd-party program to calculate each atom's charge, you can
6464
copy those charges into the "Data Atoms" section of your molecule's LT files.
6565
To prevent LAMMPS from ignoring these charges, delete or comment-out the line
6666
containing: **"include system.in.charges"** from your LAMMPS input script
6767
(such as "run.in.min", "run.in.nvt", and "run.in.npt").
6868
2) Alternatively, if you only want to override the charges of *some* of the
69-
atoms in your molecules (and use default "oplsaa.lt" charges for the remaining
69+
atoms in your molecules (and use default "oplsaa2023.lt" charges for the remaining
7070
atoms), then you can do this by adding an "In Charges" section to your LT file
7171
and providing a list of custom charges for the \$atoms you want to modify.
7272
This is demonstrated in the ["graphene_nh2.lt"](functionalized_nanotubes_NH2/moltemplate_files/graphene_nh2.lt)
@@ -94,7 +94,7 @@ of the [spce.lt](waterSPCE+methane/moltemplate_files/spce.lt) file.
9494
Sometimes, even after you have specified the (OPLSAA-specific) atom types
9595
for the atoms in your molecule, there may be multiple possible choices
9696
of dihedral, angle, or bond interactions between those atoms
97-
available in OPLSAA force field (stored in the "oplsaa.lt" file).
97+
available in OPLSAA force field (stored in the "oplsaa2023.lt" file).
9898
When that happens, moltemplate.sh will *attempt to make a reasonable guess*,
9999
chosing the original (oldest, most common) version of the interaction between
100100
those atom types. However, you can override this choice:

examples/all_atom/force_field_OPLSAA/alkane_chain_single/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ I suggest starting with the [butane](../butane) example instead.
3030

3131
### Details
3232

33-
The "Alkane50" molecule, as well as the "CH2", and "CH3" monomers it contains, use the LOPLSAA force-field. As with all of the OPLSAA examples, when we define these molecules, we only specify the atom names, bond list, and coordinates. We do not have to list the atom charges, angles, dihedrals, or impropers. The rules for creating atomic charge and angle topology are contained in the ["loplsaa.lt"](../../../../moltemplate/force_fields/loplsaa.lt) and ["oplsaa.lt"](../../../../moltemplate/force_fields/oplsaa.lt) files. To let moltemplate know that you want to use these rules, define your molecules (and molecular subunits) this way:
33+
The "Alkane50" molecule, as well as the "CH2", and "CH3" monomers it contains, use the LOPLSAA force-field. As with all of the OPLSAA examples, when we define these molecules, we only specify the atom names, bond list, and coordinates. We do not have to list the atom charges, angles, dihedrals, or impropers. The rules for creating atomic charge and angle topology are contained in the ["loplsaa2023.lt"](../../../../moltemplate/force_fields/loplsaa2023.lt) and ["oplsaa2023.lt"](../../../../moltemplate/force_fields/oplsaa2023.lt) files. To let moltemplate know that you want to use these rules, define your molecules (and molecular subunits) this way:
3434

3535

3636
```
37-
import "loplsaa.lt"
37+
import "loplsaa2023.lt"
3838
CH2 inherits OPLSAA { ... } # (see "ch2group.lt")
3939
CH3 inherits OPLSAA { ... } # (see "ch3group.lt")
4040
Alkane50 inherits OPLSAA { ... } # (see "alkane50.lt")
@@ -43,15 +43,15 @@ Alkane50 inherits OPLSAA { ... } # (see "alkane50.lt")
4343

4444
#### OPLSAA or LOPLSAA"?
4545

46-
There are only a few differences between LOPLSAA and OPLSAA. The LOPLSAA force field contains a few extra atom types and dihedral interactions which improve the accuracy of long alkane chains. The ["loplsaa.lt"](../../../../moltemplate/force_fields/loplsaa.lt) file (referenced above) incorporates these extra atom and dihedral types in the existing OPLSAA force field *instead* of creating a new force field named "LOPLSAA". *(There is no separate "LOPLSAA" force field object. I apologize if this is confusing.)* You can mix LOPLSAA and OPLSAA atoms in the same molecule.
46+
There are only a few differences between LOPLSAA and OPLSAA. The LOPLSAA force field contains a few extra atom types and dihedral interactions which improve the accuracy of long alkane chains. The ["loplsaa2023.lt"](../../../../moltemplate/force_fields/loplsaa2023.lt) file (referenced above) incorporates these extra atom and dihedral types in the existing OPLSAA force field *instead* of creating a new force field named "LOPLSAA". *(There is no separate "LOPLSAA" force field object. I apologize if this is confusing.)* You can mix LOPLSAA and OPLSAA atoms in the same molecule.
4747

4848

4949

5050
### Customizing atomic charges
5151

5252
In this example, atomic charge for OPLSAA atoms is determined by @atom type
5353
*(...according to a lookup table located at the beginning of the
54-
["oplsaa.lt"](../../../moltemplate/force_fields/oplsaa.lt) file)*.
54+
["oplsaa2023.lt"](../../../moltemplate/force_fields/oplsaa2023.lt) file)*.
5555
*(Any atomic charges listed in the "Data Atoms" section of your molecules'
5656
LT files will be ignored.)*
5757
**These charges can be overridden.**

examples/all_atom/force_field_OPLSAA/alkane_chain_single/moltemplate_files/ch2.lt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
# This file is located in the "force_fields" subdirectory
55
# distributed with moltemplate.
66

7-
import "loplsaa.lt" # <-- defines the standard "OPLSAA" force field as well as
7+
import "loplsaa2023.lt" # <-- defines the standard "OPLSAA" force field as well as
88
# custom parameters for long alkane chains taken from
99
# Sui et al. J.Chem.Theory.Comp (2012), 8, 1459
1010
# To use the ordinary OPLSAA force field parameters,
1111
# (instead of the Sui et al. parameters), change the
1212
# atom types below from "@atom:57L","@atom:60LCH2" to
13-
# "@atom:57" and "@atom:60" (defined in "oplsaa.lt")
13+
# "@atom:57" and "@atom:60" (defined in "oplsaa2023.lt")
1414

15-
# The "loplsaa.lt" and "oplsaa.lt" files are located at:
15+
# The "loplsaa2023.lt" and "oplsaa2023.lt" files are located at:
1616
# https://github.com/jewettaij/moltemplate/tree/master/moltemplate/force_fields/
1717
# If you want to customize these files, download them and copy them to this folder.
1818

@@ -34,13 +34,13 @@ CH2 inherits OPLSAA {
3434
$bond:ch2 $atom:c $atom:H2
3535
}
3636

37-
# Atom type numbers (@atom:57L,@atom:60LCH3) are defined in "loplsaa.lt",
37+
# Atom type numbers (@atom:57L,@atom:60LCH3) are defined in "loplsaa2023.lt",
3838
# @atom:54L "C - CT | n-CH3 C: alkane (LOPLS, 2012)"
3939
# @atom:57L "C - CT | CH2 C: alkanes (LOPLS, 2012)"
4040
# @atom:60LCH3 "H - HC | CH3 H: alkanes (LOPLS,2012)"
4141
# @atom:60LCH2 "H - HC | CH2 H: alkanes (LOPLS,2012)"
4242
# In this example, atomic charges are generated by atom type (according to the
43-
# rules in loplsaa.lt), and can be omitted. Just leave them as "0.0" for now.
43+
# rules in loplsaa2023.lt), and can be omitted. Just leave them as "0.0" for now.
4444
# The "..." in "$mol:..." tells moltemplate that this molecule may be part
4545
# of a larger molecule, and (if so) to use the larger parent object's
4646
# molecule id number as it's own.

examples/all_atom/force_field_OPLSAA/alkane_chain_single/moltemplate_files/ch3.lt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
# This file is located in the "force_fields" subdirectory
55
# distributed with moltemplate.
66

7-
import "loplsaa.lt" # <-- defines the standard "OPLSAA" force field as well as
7+
import "loplsaa2023.lt" # <-- defines the standard "OPLSAA" force field as well as
88
# custom parameters for long alkane chains taken from
99
# Sui et al. J.Chem.Theory.Comp (2012), 8, 1459
1010
# To use the ordinary OPLSAA force field parameters,
1111
# (instead of the Sui et al. parameters), change the
1212
# atom types below from "@atom:54L","@atom:60LCH3" to
13-
# "@atom:54" and "@atom:60" (defined in "oplsaa.lt")
13+
# "@atom:54" and "@atom:60" (defined in "oplsaa2023.lt")
1414

15-
# The "loplsaa.lt" and "oplsaa.lt" files are located at:
15+
# The "loplsaa2023.lt" and "oplsaa2023.lt" files are located at:
1616
# https://github.com/jewettaij/moltemplate/tree/master/moltemplate/force_fields/
1717
# If you want to customize these files, download them and copy them to this folder.
1818

@@ -36,13 +36,13 @@ CH3 inherits OPLSAA {
3636
$bond:ch3 $atom:c $atom:H3
3737
}
3838

39-
# Atom type numbers (@atom:54L,@atom:60LCH3) are defined in "loplsaa.lt",
39+
# Atom type numbers (@atom:54L,@atom:60LCH3) are defined in "loplsaa2023.lt",
4040
# @atom:54L "C - CT | n-CH3 C: alkane (LOPLS, 2012)"
4141
# @atom:57L "C - CT | CH2 C: alkanes (LOPLS, 2012)"
4242
# @atom:60LCH3 "H - HC | CH3 H: alkanes (LOPLS,2012)"
4343
# @atom:60LCH2 "H - HC | CH2 H: alkanes (LOPLS,2012)"
4444
# In this example, atomic charges are generated by atom type (according to the
45-
# rules in loplsaa.lt), and can be omitted. Just leave them as "0.0" for now.
45+
# rules in loplsaa2023.lt), and can be omitted. Just leave them as "0.0" for now.
4646
# The "..." in "$mol:..." tells moltemplate that this molecule may be part
4747
# of a larger molecule, and (if so) to use the larger parent object's
4848
# molecule id number as it's own.

examples/all_atom/force_field_OPLSAA/benzene+benzoic_acid/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The number of molecules, positions, and simulation box size can be controlled by
2121

2222
In this example, atomic charge for OPLSAA atoms is determined by @atom type
2323
*(...according to a lookup table located at the beginning of the
24-
["oplsaa.lt"](../../../moltemplate/force_fields/oplsaa.lt) file)*.
24+
["oplsaa2023.lt"](../../../moltemplate/force_fields/oplsaa2023.lt) file)*.
2525
*(Any atomic charges listed in the "Data Atoms" section of your molecules'
2626
LT files will be ignored.)*
2727
**These charges can be overridden.**

0 commit comments

Comments
 (0)