-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrelative.py
More file actions
2561 lines (2179 loc) · 115 KB
/
Copy pathrelative.py
File metadata and controls
2561 lines (2179 loc) · 115 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This code is a slightly modified version of the HybridTopologyFactory code
# from https://github.com/choderalab/perses
# The eventual goal is to move a version of this towards openmmtools
# LICENSE: MIT
# turn off formatting since this is mostly vendored code
# fmt: off
import logging
import openmm
from openmm import unit, app
import numpy as np
import copy
import itertools
# OpenMM constant for Coulomb interactions (implicitly in md_unit_system units)
from openmmtools.constants import ONE_4PI_EPS0
import mdtraj as mdt
logger = logging.getLogger(__name__)
class HybridTopologyFactory:
"""
This class generates a hybrid topology based on two input systems and an
atom mapping. For convenience the states are called "old" and "new"
respectively, defining the starting and end states along the alchemical
transformation.
The input systems are assumed to have:
1. The total number of molecules
2. The same coordinates for equivalent atoms
Atoms in the resulting hybrid system are treated as being from one
of four possible types:
unique_old_atom : These atoms are not mapped and only present in the old
system. Their interactions will be on for lambda=0, off for lambda=1
unique_new_atom : These atoms are not mapped and only present in the new
system. Their interactions will be off for lambda=0, on for lambda=1
core_atom : These atoms are mapped between the two end states, and are
part of a residue that is changing alchemically. Their interactions
will be those corresponding to the old system at lambda=0, and those
corresponding to the new system at lambda=1
environment_atom : These atoms are mapped between the two end states, and
are not part of a residue undergoing an alchemical change. Their
interactions are always on and are alchemically unmodified.
Properties
----------
hybrid_system : openmm.System
The hybrid system for simulation
new_to_hybrid_atom_map : dict of int : int
The mapping of new system atoms to hybrid atoms
old_to_hybrid_atom_map : dict of int : int
The mapping of old system atoms to hybrid atoms
hybrid_positions : [n, 3] np.ndarray
The positions of the hybrid system
hybrid_topology : mdtraj.Topology
The topology of the hybrid system
omm_hybrid_topology : openmm.app.Topology
The OpenMM topology object corresponding to the hybrid system
.. warning :: This API is experimental and subject to change.
Notes
-----
* Logging has been removed and will be revamped at a later date.
* The ability to define custom functions has been removed for now.
* Neglected angle terms have been removed for now.
* RMSD restraint option has been removed for now.
* Endstate support has been removed for now.
* Bond softening has been removed for now.
* Unused InteractionGroup code paths have been removed.
TODO
----
* Document how positions for hybrid system are constructed.
* Allow support for annealing in omitted terms.
* Implement omitted terms (this was not available in the original class).
"""
def __init__(self,
old_system, old_positions, old_topology,
new_system, new_positions, new_topology,
old_to_new_atom_map, old_to_new_core_atom_map,
use_dispersion_correction=False,
softcore_alpha=0.5,
softcore_LJ_v2=True,
softcore_LJ_v2_alpha=0.85,
interpolate_old_and_new_14s=False):
"""
Initialize the Hybrid topology factory.
Parameters
----------
old_system : openmm.System
OpenMM system defining the "old" (i.e. starting) state.
old_positions : [n,3] np.ndarray of float
The positions of the "old system".
old_topology : openmm.Topology
OpenMM topology defining the "old" state.
new_system: opemm.System
OpenMM system defining the "new" (i.e. end) state.
new_positions : [m,3] np.ndarray of float
The positions of the "new system"
new_topology : openmm.Topology
OpenMM topology defining the "new" state.
old_to_new_atom_map : dict of int : int
Dictionary of corresponding atoms between the old and new systems.
Unique atoms are not included in this atom map.
old_to_new_core_atom_map : dict of int : int
Dictionary of corresponding atoms between the alchemical "core
atoms" (i.e. residues which are changing) between the old and
new systems.
use_dispersion_correction : bool, default False
Whether to use the long range correction in the custom sterics
force. This can be very expensive for NCMC.
softcore_alpha: float, default None
"alpha" parameter of softcore sterics, default 0.5.
softcore_LJ_v2 : bool, default True
Implement the softcore LJ as defined by Gapsys et al. JCTC 2012.
softcore_LJ_v2_alpha : float, default 0.85
Softcore alpha parameter for LJ v2
interpolate_old_and_new_14s : bool, default False
Whether to turn off interactions for new exceptions (not just
1,4s) at lambda = 0 and old exceptions at lambda = 1; if False,
they are present in the nonbonded force.
"""
# Assign system positions and force
# IA - Are deep copies really needed here?
self._old_system = copy.deepcopy(old_system)
self._old_positions = old_positions
self._old_topology = old_topology
self._new_system = copy.deepcopy(new_system)
self._new_positions = new_positions
self._new_topology = new_topology
self._hybrid_system_forces = dict()
# Set mappings (full, core, and env maps)
self._set_mappings(old_to_new_atom_map, old_to_new_core_atom_map)
# Other options
self._use_dispersion_correction = use_dispersion_correction
self._interpolate_14s = interpolate_old_and_new_14s
# Sofcore options
self._softcore_alpha = softcore_alpha
self._check_bounds(softcore_alpha, "softcore_alpha") # [0,1] check
self._softcore_LJ_v2 = softcore_LJ_v2
if self._softcore_LJ_v2:
self._check_bounds(softcore_LJ_v2_alpha, "softcore_LJ_v2_alpha")
self._softcore_LJ_v2_alpha = softcore_LJ_v2_alpha
# TODO: end __init__ here and move everything else to
# create_hybrid_system() or equivalent
self._check_and_store_system_forces()
logger.info("Creating hybrid system")
# Create empty system that will become the hybrid system
self._hybrid_system = openmm.System()
# Add particles to system
self._add_particles()
# Add box + barostat
self._handle_box()
# Assign atoms to one of the classes described in the class docstring
# Renamed from original _determine_atom_classes
self._set_atom_classes()
# Construct dictionary of exceptions in old and new systems
self._old_system_exceptions = self._generate_dict_from_exceptions(
self._old_system_forces['NonbondedForce'])
self._new_system_exceptions = self._generate_dict_from_exceptions(
self._new_system_forces['NonbondedForce'])
# check for exceptions clashes between unique and env atoms
self._validate_disjoint_sets()
logger.info("Setting force field terms")
# Copy constraints, checking to make sure they are not changing
self._handle_constraints()
# Copy over relevant virtual sites - pick up refactor from here
self._handle_virtual_sites()
# TODO - move to a single method call? Would be good to group these
# Call each of the force methods to add the corresponding force terms
# and prepare the forces:
self._add_bond_force_terms()
self._add_angle_force_terms()
self._add_torsion_force_terms()
has_nonbonded_force = ('NonbondedForce' in self._old_system_forces or
'NonbondedForce' in self._new_system_forces)
if has_nonbonded_force:
self._add_nonbonded_force_terms()
# Call each force preparation method to generate the actual
# interactions that we need:
logger.info("Adding forces")
self._handle_harmonic_bonds()
self._handle_harmonic_angles()
self._handle_periodic_torsion_force()
if has_nonbonded_force:
self._handle_nonbonded()
if not (len(self._old_system_exceptions.keys()) == 0 and
len(self._new_system_exceptions.keys()) == 0):
self._handle_old_new_exceptions()
# Get positions for the hybrid
self._hybrid_positions = self._compute_hybrid_positions()
# Get an MDTraj topology for writing
self._hybrid_topology = self._create_mdtraj_topology()
self._omm_hybrid_topology = self._create_hybrid_topology()
logger.info("Hybrid system created")
@staticmethod
def _check_bounds(value, varname, minmax=(0, 1)):
"""
Convenience method to check the bounds of a value.
Parameters
----------
value : float
Value to evaluate.
varname : str
Name of value to raise in error message
minmax : tuple
Two element tuple with the lower and upper bounds to check.
Raises
------
AssertionError
If value is lower or greater than bounds.
"""
if value < minmax[0] or value > minmax[1]:
raise AssertionError(f"{varname} is not in {minmax}")
@staticmethod
def _invert_dict(dictionary):
"""
Convenience method to invert a dictionary (since we do it so often).
Paramters:
----------
dictionary : dict
Dictionary you want to invert
"""
return {v: k for k, v in dictionary.items()}
def _set_mappings(self, old_to_new_map, core_old_to_new_map):
"""
Parameters
----------
old_to_new_map : dict of int : int
Dictionary mapping atoms between the old and new systems.
Notes
-----
* For now this directly sets the system, core and env old_to_new_map,
new_to_old_map, an empty new_to_hybrid_map and an empty
old_to_hybrid_map. In the future this will be moved to the one
dictionary to make things a lot less confusing.
"""
self._old_to_new_map = old_to_new_map
self._core_old_to_new_map = core_old_to_new_map
self._new_to_old_map = self._invert_dict(old_to_new_map)
self._core_new_to_old_map = self._invert_dict(core_old_to_new_map)
self._old_to_hybrid_map = {}
self._new_to_hybrid_map = {}
# Get unique atoms
# old system first
self._unique_old_atoms = []
for particle_idx in range(self._old_system.getNumParticles()):
if particle_idx not in self._old_to_new_map.keys():
self._unique_old_atoms.append(particle_idx)
self._unique_new_atoms = []
for particle_idx in range(self._new_system.getNumParticles()):
if particle_idx not in self._new_to_old_map.keys():
self._unique_new_atoms.append(particle_idx)
# Get env atoms (i.e. atoms mapped not in core)
self._env_old_to_new_map = {}
for key, value in old_to_new_map.items():
if key not in self._core_old_to_new_map.keys():
self._env_old_to_new_map[key] = value
self._env_new_to_old_map = self._invert_dict(self._env_old_to_new_map)
# IA - Internal check for now (move to test later)
num_env = len(self._env_old_to_new_map.keys())
num_core = len(self._core_old_to_new_map.keys())
num_total = len(self._old_to_new_map.keys())
assert num_env + num_core == num_total
def _check_and_store_system_forces(self):
"""
Conveniently stores the system forces and checks that no unknown
forces exist.
"""
def _check_unknown_forces(forces, system_name):
# TODO: double check that CMMotionRemover is ok being here
known_forces = {'HarmonicBondForce', 'HarmonicAngleForce',
'PeriodicTorsionForce', 'NonbondedForce',
'MonteCarloBarostat', 'CMMotionRemover'}
force_names = forces.keys()
unknown_forces = set(force_names) - set(known_forces)
if unknown_forces:
errmsg = (f"Unknown forces {unknown_forces} encountered in "
f"{system_name} system")
raise ValueError(errmsg)
# Prepare dicts of forces, which will be useful later
# TODO: Store this as self._system_forces[name], name in ('old',
# 'new', 'hybrid') for compactness
self._old_system_forces = {type(force).__name__: force for force in
self._old_system.getForces()}
_check_unknown_forces(self._old_system_forces, 'old')
self._new_system_forces = {type(force).__name__: force for force in
self._new_system.getForces()}
_check_unknown_forces(self._new_system_forces, 'new')
# TODO: check if this is actually used much, otherwise ditch it
# Get and store the nonbonded method from the system:
self._nonbonded_method = self._old_system_forces['NonbondedForce'].getNonbondedMethod()
def _add_particles(self):
"""
Adds particles to the hybrid system.
This does not copy over interactions, but does copy over the masses.
Note
----
* If there is a difference in masses between the old and new systems
the average mass of the two is used.
TODO
----
* Review influence of lack of mass scaling.
"""
# Begin by copying all particles in the old system
for particle_idx in range(self._old_system.getNumParticles()):
mass_old = self._old_system.getParticleMass(particle_idx)
if particle_idx in self._old_to_new_map.keys():
particle_idx_new_system = self._old_to_new_map[particle_idx]
mass_new = self._new_system.getParticleMass(
particle_idx_new_system)
# Take the average of the masses if the atom is mapped
particle_mass = (mass_old + mass_new) / 2
else:
particle_mass = mass_old
hybrid_idx = self._hybrid_system.addParticle(particle_mass)
self._old_to_hybrid_map[particle_idx] = hybrid_idx
# If the particle index in question is mapped, make sure to add it
# to the new to hybrid map as well.
if particle_idx in self._old_to_new_map.keys():
self._new_to_hybrid_map[particle_idx_new_system] = hybrid_idx
# Next, add the remaining unique atoms from the new system to the
# hybrid system and map accordingly.
for particle_idx in self._unique_new_atoms:
particle_mass = self._new_system.getParticleMass(particle_idx)
hybrid_idx = self._hybrid_system.addParticle(particle_mass)
self._new_to_hybrid_map[particle_idx] = hybrid_idx
# Create the opposite atom maps for later use (nonbonded processing)
self._hybrid_to_old_map = self._invert_dict(self._old_to_hybrid_map)
self._hybrid_to_new_map = self._invert_dict(self._new_to_hybrid_map)
def _handle_box(self):
"""
Copies over the barostat and box vectors as necessary.
"""
# Check that if there is a barostat in the old system,
# it is added to the hybrid system
if "MonteCarloBarostat" in self._old_system_forces.keys():
barostat = copy.deepcopy(
self._old_system_forces["MonteCarloBarostat"])
self._hybrid_system.addForce(barostat)
# Copy over the box vectors from the old system
box_vectors = self._old_system.getDefaultPeriodicBoxVectors()
self._hybrid_system.setDefaultPeriodicBoxVectors(*box_vectors)
def _set_atom_classes(self):
"""
This method determines whether each atom belongs to unique old,
unique new, core, or environment, as defined in the class docstring.
All indices are indices in the hybrid system.
"""
self._atom_classes = {'unique_old_atoms': set(),
'unique_new_atoms': set(),
'core_atoms': set(),
'environment_atoms': set()}
# First, find the unique old atoms
for atom_idx in self._unique_old_atoms:
hybrid_idx = self._old_to_hybrid_map[atom_idx]
self._atom_classes['unique_old_atoms'].add(hybrid_idx)
# Then the unique new atoms
for atom_idx in self._unique_new_atoms:
hybrid_idx = self._new_to_hybrid_map[atom_idx]
self._atom_classes['unique_new_atoms'].add(hybrid_idx)
# The core atoms:
for new_idx, old_idx in self._core_new_to_old_map.items():
new_to_hybrid_idx = self._new_to_hybrid_map[new_idx]
old_to_hybrid_idx = self._old_to_hybrid_map[old_idx]
if new_to_hybrid_idx != old_to_hybrid_idx:
errmsg = (f"there is an index collision in hybrid indices of "
f"the core atom map: {self._core_new_to_old_map}")
raise AssertionError(errmsg)
self._atom_classes['core_atoms'].add(new_to_hybrid_idx)
# The environment atoms:
for new_idx, old_idx in self._env_new_to_old_map.items():
new_to_hybrid_idx = self._new_to_hybrid_map[new_idx]
old_to_hybrid_idx = self._old_to_hybrid_map[old_idx]
if new_to_hybrid_idx != old_to_hybrid_idx:
errmsg = (f"there is an index collion in hybrid indices of "
f"the environment atom map: "
f"{self._env_new_to_old_map}")
raise AssertionError(errmsg)
self._atom_classes['environment_atoms'].add(new_to_hybrid_idx)
@staticmethod
def _generate_dict_from_exceptions(force):
"""
This is a utility function to generate a dictionary of the form
(particle1_idx, particle2_idx) : [exception parameters].
This will facilitate access and search of exceptions.
Parameters
----------
force : openmm.NonbondedForce object
a force containing exceptions
Returns
-------
exceptions_dict : dict
Dictionary of exceptions
"""
exceptions_dict = {}
for exception_index in range(force.getNumExceptions()):
[index1, index2, chargeProd, sigma, epsilon] = force.getExceptionParameters(exception_index)
exceptions_dict[(index1, index2)] = [chargeProd, sigma, epsilon]
return exceptions_dict
def _validate_disjoint_sets(self):
"""
Conduct a sanity check to make sure that the hybrid maps of the old
and new system exception dict keys do not contain both environment
and unique_old/new atoms.
TODO: repeated code - condense
"""
for old_indices in self._old_system_exceptions.keys():
hybrid_indices = (self._old_to_hybrid_map[old_indices[0]],
self._old_to_hybrid_map[old_indices[1]])
old_env_intersection = set(old_indices).intersection(
self._atom_classes['environment_atoms'])
if old_env_intersection:
if set(old_indices).intersection(
self._atom_classes['unique_old_atoms']
):
errmsg = (f"old index exceptions {old_indices} include "
"unique old and environment atoms, which is "
"disallowed")
raise AssertionError(errmsg)
for new_indices in self._new_system_exceptions.keys():
hybrid_indices = (self._new_to_hybrid_map[new_indices[0]],
self._new_to_hybrid_map[new_indices[1]])
new_env_intersection = set(hybrid_indices).intersection(
self._atom_classes['environment_atoms'])
if new_env_intersection:
if set(hybrid_indices).intersection(
self._atom_classes['unique_new_atoms']
):
errmsg = (f"new index exceptions {new_indices} include "
"unique new and environment atoms, which is "
"dissallowed")
raise AssertionError
def _handle_constraints(self):
"""
This method adds relevant constraints from the old and new systems.
First, all constraints from the old systenm are added.
Then, constraints to atoms unique to the new system are added.
TODO: condense duplicated code
"""
# lengths of constraints already added
constraint_lengths = dict()
# old system
hybrid_map = self._old_to_hybrid_map
for const_idx in range(self._old_system.getNumConstraints()):
at1, at2, length = self._old_system.getConstraintParameters(
const_idx)
hybrid_atoms = tuple(sorted([hybrid_map[at1], hybrid_map[at2]]))
if hybrid_atoms not in constraint_lengths.keys():
self._hybrid_system.addConstraint(hybrid_atoms[0],
hybrid_atoms[1], length)
constraint_lengths[hybrid_atoms] = length
else:
if constraint_lengths[hybrid_atoms] != length:
raise AssertionError('constraint length is changing')
# new system
hybrid_map = self._new_to_hybrid_map
for const_idx in range(self._new_system.getNumConstraints()):
at1, at2, length = self._new_system.getConstraintParameters(
const_idx)
hybrid_atoms = tuple(sorted([hybrid_map[at1], hybrid_map[at2]]))
if hybrid_atoms not in constraint_lengths.keys():
self._hybrid_system.addConstraint(hybrid_atoms[0],
hybrid_atoms[1], length)
constraint_lengths[hybrid_atoms] = length
else:
if constraint_lengths[hybrid_atoms] != length:
raise AssertionError('constraint length is changing')
@staticmethod
def _copy_threeparticleavg(atm_map, env_atoms, vs):
"""
Helper method to copy a ThreeParticleAverageSite virtual site
from two mapped Systems.
Parameters
----------
atm_map : dict[int, int]
The atom map correspondance between the two Systems.
env_atoms: set[int]
A list of environment atoms for the target System. This
checks that no alchemical atoms are being tied to.
vs : openmm.ThreeParticleAverageSite
Returns
-------
openmm.ThreeParticleAverageSite
"""
particles = {}
weights = {}
for i in range(vs.getNumParticles()):
particles[i] = atm_map[vs.getParticle(i)]
weights[i] = vs.getWeight(i)
if not all(i in env_atoms for i in particles.values()):
errmsg = ("Virtual sites bound to non-environment atoms "
"are not supported")
raise ValueError(errmsg)
return openmm.ThreeParticleAverageSite(
particles[0], particles[1], particles[2],
weights[0], weights[1], weights[2],
)
def _handle_virtual_sites(self):
"""
Ensure that all virtual sites in old and new system are copied over to
the hybrid system. Note that we do not support virtual sites in the
changing region.
TODO - remerge into a single loop
TODO - check that it's fine to double count here (even so, there's
an optimisation that could be done here...)
"""
# old system
# Loop through virtual sites
for particle_idx in range(self._old_system.getNumParticles()):
if self._old_system.isVirtualSite(particle_idx):
# If it's a virtual site, make sure it is not in the unique or
# core atoms, since this is currently unsupported
hybrid_idx = self._old_to_hybrid_map[particle_idx]
if hybrid_idx not in self._atom_classes['environment_atoms']:
errmsg = ("Virtual sites in changing residue are "
"unsupported.")
raise ValueError(errmsg)
else:
virtual_site = self._old_system.getVirtualSite(
particle_idx)
if isinstance(
virtual_site, openmm.ThreeParticleAverageSite):
vs_copy = self._copy_threeparticleavg(
self._old_to_hybrid_map,
self._atom_classes['environment_atoms'],
virtual_site,
)
else:
errmsg = ("Unsupported VirtualSite "
f"class: {virtual_site}")
raise ValueError(errmsg)
self._hybrid_system.setVirtualSite(hybrid_idx,
vs_copy)
# new system - there should be nothing left to add
# Loop through virtual sites
for particle_idx in range(self._new_system.getNumParticles()):
if self._new_system.isVirtualSite(particle_idx):
# If it's a virtual site, make sure it is not in the unique or
# core atoms, since this is currently unsupported
hybrid_idx = self._new_to_hybrid_map[particle_idx]
if hybrid_idx not in self._atom_classes['environment_atoms']:
errmsg = ("Virtual sites in changing residue are "
"unsupported.")
raise ValueError(errmsg)
else:
if not self._hybrid_system.isVirtualSite(hybrid_idx):
errmsg = ("Environment virtual site in new system "
"found not copied from old system")
raise ValueError(errmsg)
def _add_bond_force_terms(self):
"""
This function adds the appropriate bond forces to the system
(according to groups defined in the main class docstring). Note that
it does _not_ add the particles to the force. It only adds the force
to facilitate another method adding the particles to the force.
Notes
-----
* User defined functions have been removed for now.
"""
core_energy_expression = '(K/2)*(r-length)^2;'
# linearly interpolate spring constant
core_energy_expression += 'K = (1-lambda_bonds)*K1 + lambda_bonds*K2;'
# linearly interpolate bond length
core_energy_expression += 'length = (1-lambda_bonds)*length1 + lambda_bonds*length2;'
# Create the force and add the relevant parameters
custom_core_force = openmm.CustomBondForce(core_energy_expression)
custom_core_force.addPerBondParameter('length1') # old bond length
custom_core_force.addPerBondParameter('K1') # old spring constant
custom_core_force.addPerBondParameter('length2') # new bond length
custom_core_force.addPerBondParameter('K2') # new spring constant
custom_core_force.addGlobalParameter('lambda_bonds', 0.0)
self._hybrid_system.addForce(custom_core_force)
self._hybrid_system_forces['core_bond_force'] = custom_core_force
# Add a bond force for environment and unique atoms (bonds are never
# scaled for these):
standard_bond_force = openmm.HarmonicBondForce()
self._hybrid_system.addForce(standard_bond_force)
self._hybrid_system_forces['standard_bond_force'] = standard_bond_force
def _add_angle_force_terms(self):
"""
This function adds the appropriate angle force terms to the hybrid
system. It does not add particles or parameters to the force; this is
done elsewhere.
Notes
-----
* User defined functions have been removed for now.
* Neglected angle terms have been removed for now.
"""
energy_expression = '(K/2)*(theta-theta0)^2;'
# linearly interpolate spring constant
energy_expression += 'K = (1.0-lambda_angles)*K_1 + lambda_angles*K_2;'
# linearly interpolate equilibrium angle
energy_expression += 'theta0 = (1.0-lambda_angles)*theta0_1 + lambda_angles*theta0_2;'
# Create the force and add relevant parameters
custom_core_force = openmm.CustomAngleForce(energy_expression)
# molecule1 equilibrium angle
custom_core_force.addPerAngleParameter('theta0_1')
# molecule1 spring constant
custom_core_force.addPerAngleParameter('K_1')
# molecule2 equilibrium angle
custom_core_force.addPerAngleParameter('theta0_2')
# molecule2 spring constant
custom_core_force.addPerAngleParameter('K_2')
custom_core_force.addGlobalParameter('lambda_angles', 0.0)
# Add the force to the system and the force dict.
self._hybrid_system.addForce(custom_core_force)
self._hybrid_system_forces['core_angle_force'] = custom_core_force
# Add an angle term for environment/unique interactions -- these are
# never scaled
standard_angle_force = openmm.HarmonicAngleForce()
self._hybrid_system.addForce(standard_angle_force)
self._hybrid_system_forces['standard_angle_force'] = standard_angle_force
def _add_torsion_force_terms(self):
"""
This function adds the appropriate PeriodicTorsionForce terms to the
system. Core torsions are interpolated, while environment and unique
torsions are always on.
Notes
-----
* User defined functions have been removed for now.
* Options for add_custom_core_force (default True) and
add_unique_atom_torsion_force (default True) have been removed for
now.
"""
energy_expression = '(1-lambda_torsions)*U1 + lambda_torsions*U2;'
energy_expression += 'U1 = K1*(1+cos(periodicity1*theta-phase1));'
energy_expression += 'U2 = K2*(1+cos(periodicity2*theta-phase2));'
# Create the force and add the relevant parameters
custom_core_force = openmm.CustomTorsionForce(energy_expression)
# molecule1 periodicity
custom_core_force.addPerTorsionParameter('periodicity1')
# molecule1 phase
custom_core_force.addPerTorsionParameter('phase1')
# molecule1 spring constant
custom_core_force.addPerTorsionParameter('K1')
# molecule2 periodicity
custom_core_force.addPerTorsionParameter('periodicity2')
# molecule2 phase
custom_core_force.addPerTorsionParameter('phase2')
# molecule2 spring constant
custom_core_force.addPerTorsionParameter('K2')
custom_core_force.addGlobalParameter('lambda_torsions', 0.0)
# Add the force to the system
self._hybrid_system.addForce(custom_core_force)
self._hybrid_system_forces['custom_torsion_force'] = custom_core_force
# Create and add the torsion term for unique/environment atoms
unique_atom_torsion_force = openmm.PeriodicTorsionForce()
self._hybrid_system.addForce(unique_atom_torsion_force)
self._hybrid_system_forces['unique_atom_torsion_force'] = unique_atom_torsion_force
@staticmethod
def _nonbonded_custom(v2):
"""
Get a part of the nonbonded energy expression when there is no cutoff.
Parameters
----------
v2 : bool
Whether to use the softcore methods as defined by Gapsys et al.
JCTC 2012.
Returns
-------
sterics_energy_expression : str
The energy expression for U_sterics
electrostatics_energy_expression : str
The energy expression for electrostatics
TODO
----
* Move to a dictionary or equivalent.
"""
# Soft-core Lennard-Jones
if v2:
sterics_energy_expression = "U_sterics = select(step(r - r_LJ), 4*epsilon*x*(x-1.0), U_sterics_quad);"
sterics_energy_expression += "U_sterics_quad = Force*(((r - r_LJ)^2)/2 - (r - r_LJ)) + U_sterics_cut;"
sterics_energy_expression += "U_sterics_cut = 4*epsilon*((sigma/r_LJ)^6)*(((sigma/r_LJ)^6) - 1.0);"
sterics_energy_expression += "Force = -4*epsilon*((-12*sigma^12)/(r_LJ^13) + (6*sigma^6)/(r_LJ^7));"
sterics_energy_expression += "x = (sigma/r)^6;"
sterics_energy_expression += "r_LJ = softcore_alpha*((26/7)*(sigma^6)*lambda_sterics_deprecated)^(1/6);"
sterics_energy_expression += "lambda_sterics_deprecated = new_interaction*(1.0 - lambda_sterics_insert) + old_interaction*lambda_sterics_delete;"
else:
sterics_energy_expression = "U_sterics = 4*epsilon*x*(x-1.0); x = (sigma/reff_sterics)^6;"
return sterics_energy_expression
@staticmethod
def _nonbonded_custom_sterics_common():
"""
Get a custom sterics expression using amber softcore expression
Returns
-------
sterics_addition : str
The common softcore sterics energy expression
TODO
----
* Move to a dictionary or equivalent.
"""
# interpolation
sterics_addition = "epsilon = (1-lambda_sterics)*epsilonA + lambda_sterics*epsilonB;"
# effective softcore distance for sterics
sterics_addition += "reff_sterics = sigma*((softcore_alpha*lambda_alpha + (r/sigma)^6))^(1/6);"
sterics_addition += "sigma = (1-lambda_sterics)*sigmaA + lambda_sterics*sigmaB;"
sterics_addition += "lambda_alpha = new_interaction*(1-lambda_sterics_insert) + old_interaction*lambda_sterics_delete;"
sterics_addition += "lambda_sterics = core_interaction*lambda_sterics_core + new_interaction*lambda_sterics_insert + old_interaction*lambda_sterics_delete;"
sterics_addition += "core_interaction = delta(unique_old1+unique_old2+unique_new1+unique_new2);new_interaction = max(unique_new1, unique_new2);old_interaction = max(unique_old1, unique_old2);"
return sterics_addition
@staticmethod
def _nonbonded_custom_mixing_rules():
"""
Mixing rules for the custom nonbonded force.
Returns
-------
sterics_mixing_rules : str
The mixing expression for sterics
electrostatics_mixing_rules : str
The mixiing rules for electrostatics
TODO
----
* Move to a dictionary or equivalent.
"""
# Define mixing rules.
# mixing rule for epsilon
sterics_mixing_rules = "epsilonA = sqrt(epsilonA1*epsilonA2);"
# mixing rule for epsilon
sterics_mixing_rules += "epsilonB = sqrt(epsilonB1*epsilonB2);"
# mixing rule for sigma
sterics_mixing_rules += "sigmaA = 0.5*(sigmaA1 + sigmaA2);"
# mixing rule for sigma
sterics_mixing_rules += "sigmaB = 0.5*(sigmaB1 + sigmaB2);"
return sterics_mixing_rules
@staticmethod
def _translate_nonbonded_method_to_custom(standard_nonbonded_method):
"""
Utility function to translate the nonbonded method enum from the
standard nonbonded force to the custom version
`CutoffPeriodic`, `PME`, and `Ewald` all become `CutoffPeriodic`;
`NoCutoff` becomes `NoCutoff`; `CutoffNonPeriodic` becomes
`CutoffNonPeriodic`
Parameters
----------
standard_nonbonded_method : openmm.NonbondedForce.NonbondedMethod
the nonbonded method of the standard force
Returns
-------
custom_nonbonded_method : openmm.CustomNonbondedForce.NonbondedMethod
the nonbonded method for the equivalent customnonbonded force
"""
if standard_nonbonded_method in [openmm.NonbondedForce.CutoffPeriodic,
openmm.NonbondedForce.PME,
openmm.NonbondedForce.Ewald]:
return openmm.CustomNonbondedForce.CutoffPeriodic
elif standard_nonbonded_method == openmm.NonbondedForce.NoCutoff:
return openmm.CustomNonbondedForce.NoCutoff
elif standard_nonbonded_method == openmm.NonbondedForce.CutoffNonPeriodic:
return openmm.CustomNonbondedForce.CutoffNonPeriodic
else:
errmsg = "This nonbonded method is not supported."
raise NotImplementedError(errmsg)
def _add_nonbonded_force_terms(self):
"""
Add the nonbonded force terms to the hybrid system. Note that as with
the other forces, this method does not add any interactions. It only
sets up the forces.
Notes
-----
* User defined functions have been removed for now.
* Argument `add_custom_sterics_force` (default True) has been removed
for now.
TODO
----
* Move nonbonded_method defn here to avoid just setting it globally
and polluting `self`.
"""
# Add a regular nonbonded force for all interactions that are not
# changing.
standard_nonbonded_force = openmm.NonbondedForce()
self._hybrid_system.addForce(standard_nonbonded_force)
self._hybrid_system_forces['standard_nonbonded_force'] = standard_nonbonded_force
# Create a CustomNonbondedForce to handle alchemically interpolated
# nonbonded parameters.
# Select functional form based on nonbonded method.
# TODO: check _nonbonded_custom_ewald and _nonbonded_custom_cutoff
# since they take arguments that are never used...
r_cutoff = self._old_system_forces['NonbondedForce'].getCutoffDistance()
sterics_energy_expression = self._nonbonded_custom(self._softcore_LJ_v2)
if self._nonbonded_method in [openmm.NonbondedForce.NoCutoff]:
sterics_energy_expression = self._nonbonded_custom(
self._softcore_LJ_v2)
elif self._nonbonded_method in [openmm.NonbondedForce.CutoffPeriodic,
openmm.NonbondedForce.CutoffNonPeriodic]:
epsilon_solvent = self._old_system_forces['NonbondedForce'].getReactionFieldDielectric()
standard_nonbonded_force.setReactionFieldDielectric(
epsilon_solvent)
standard_nonbonded_force.setCutoffDistance(r_cutoff)
elif self._nonbonded_method in [openmm.NonbondedForce.PME,
openmm.NonbondedForce.Ewald]:
[alpha_ewald, nx, ny, nz] = self._old_system_forces['NonbondedForce'].getPMEParameters()
delta = self._old_system_forces['NonbondedForce'].getEwaldErrorTolerance()
standard_nonbonded_force.setPMEParameters(alpha_ewald, nx, ny, nz)
standard_nonbonded_force.setEwaldErrorTolerance(delta)
standard_nonbonded_force.setCutoffDistance(r_cutoff)
else:
errmsg = f"Nonbonded method {self._nonbonded_method} not supported"
raise ValueError(errmsg)
standard_nonbonded_force.setNonbondedMethod(self._nonbonded_method)
sterics_energy_expression += self._nonbonded_custom_sterics_common()
sterics_mixing_rules = self._nonbonded_custom_mixing_rules()
custom_nonbonded_method = self._translate_nonbonded_method_to_custom(
self._nonbonded_method)
total_sterics_energy = "U_sterics;" + sterics_energy_expression + sterics_mixing_rules
sterics_custom_nonbonded_force = openmm.CustomNonbondedForce(
total_sterics_energy)
# Match cutoff from non-custom NB forces
sterics_custom_nonbonded_force.setCutoffDistance(r_cutoff)
if self._softcore_LJ_v2:
sterics_custom_nonbonded_force.addGlobalParameter(
"softcore_alpha", self._softcore_LJ_v2_alpha)
else:
sterics_custom_nonbonded_force.addGlobalParameter(
"softcore_alpha", self._softcore_alpha)
# Lennard-Jones sigma initial
sterics_custom_nonbonded_force.addPerParticleParameter("sigmaA")
# Lennard-Jones epsilon initial
sterics_custom_nonbonded_force.addPerParticleParameter("epsilonA")
# Lennard-Jones sigma final
sterics_custom_nonbonded_force.addPerParticleParameter("sigmaB")
# Lennard-Jones epsilon final
sterics_custom_nonbonded_force.addPerParticleParameter("epsilonB")
# 1 = hybrid old atom, 0 otherwise
sterics_custom_nonbonded_force.addPerParticleParameter("unique_old")
# 1 = hybrid new atom, 0 otherwise
sterics_custom_nonbonded_force.addPerParticleParameter("unique_new")
sterics_custom_nonbonded_force.addGlobalParameter(
"lambda_sterics_core", 0.0)
sterics_custom_nonbonded_force.addGlobalParameter(
"lambda_electrostatics_core", 0.0)
sterics_custom_nonbonded_force.addGlobalParameter(
"lambda_sterics_insert", 0.0)
sterics_custom_nonbonded_force.addGlobalParameter(
"lambda_sterics_delete", 0.0)
sterics_custom_nonbonded_force.setNonbondedMethod(
custom_nonbonded_method)
self._hybrid_system.addForce(sterics_custom_nonbonded_force)
self._hybrid_system_forces['core_sterics_force'] = sterics_custom_nonbonded_force
# Set the use of dispersion correction to be the same between the new
# nonbonded force and the old one:
if self._old_system_forces['NonbondedForce'].getUseDispersionCorrection():
self._hybrid_system_forces['standard_nonbonded_force'].setUseDispersionCorrection(True)
if self._use_dispersion_correction:
sterics_custom_nonbonded_force.setUseLongRangeCorrection(True)
else:
self._hybrid_system_forces['standard_nonbonded_force'].setUseDispersionCorrection(False)
if self._old_system_forces['NonbondedForce'].getUseSwitchingFunction():
switching_distance = self._old_system_forces['NonbondedForce'].getSwitchingDistance()
standard_nonbonded_force.setUseSwitchingFunction(True)
standard_nonbonded_force.setSwitchingDistance(switching_distance)
sterics_custom_nonbonded_force.setUseSwitchingFunction(True)
sterics_custom_nonbonded_force.setSwitchingDistance(switching_distance)
else:
standard_nonbonded_force.setUseSwitchingFunction(False)
sterics_custom_nonbonded_force.setUseSwitchingFunction(False)
@staticmethod
def _find_bond_parameters(bond_force, index1, index2):
"""
This is a convenience function to find bond parameters in another