View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2025.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  // ******************************************************************************
38  package ffx.potential.openmm;
39  
40  import ffx.openmm.Force;
41  import ffx.openmm.PeriodicTorsionForce;
42  import ffx.potential.bonded.Torsion;
43  import ffx.potential.parameters.ForceField;
44  import ffx.potential.parameters.TorsionType;
45  
46  import java.util.logging.Level;
47  import java.util.logging.Logger;
48  
49  import static edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_KJPerKcal;
50  import static edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_RadiansPerDegree;
51  import static java.lang.String.format;
52  
53  public class TorsionForce extends PeriodicTorsionForce {
54  
55    private static final Logger logger = Logger.getLogger(TorsionForce.class.getName());
56  
57    private final boolean manyBodyTitration;
58  
59    private double lambdaTorsion = 1.0;
60  
61    public TorsionForce(OpenMMEnergy openMMEnergy) {
62      ForceField forceField = openMMEnergy.getMolecularAssembly().getForceField();
63      manyBodyTitration = forceField.getBoolean("MANYBODY_TITRATION", false);
64      Torsion[] torsions = openMMEnergy.getTorsions();
65      if (torsions == null || torsions.length < 1) {
66        return;
67      }
68  
69      for (Torsion torsion : torsions) {
70        int a1 = torsion.getAtom(0).getXyzIndex() - 1;
71        int a2 = torsion.getAtom(1).getXyzIndex() - 1;
72        int a3 = torsion.getAtom(2).getXyzIndex() - 1;
73        int a4 = torsion.getAtom(3).getXyzIndex() - 1;
74        TorsionType torsionType = torsion.torsionType;
75        int nTerms = torsionType.phase.length;
76        for (int j = 0; j < nTerms; j++) {
77          double k = torsion.getTorsionScale() * torsionType.torsionUnit * torsionType.amplitude[j];
78          addTorsion(a1, a2, a3, a4, j + 1,
79              torsionType.phase[j] * OpenMM_RadiansPerDegree, OpenMM_KJPerKcal * k);
80        }
81        // Enforce 6-fold torsions since TorsionType instances can have different lengths
82        // when side-chain protonation changes.
83        if (manyBodyTitration) {
84          for (int j = nTerms; j < 6; j++) {
85            addTorsion(a1, a2, a3, a4, j + 1, 0.0, 0.0);
86          }
87        }
88      }
89  
90      int forceGroup = forceField.getInteger("TORSION_FORCE_GROUP", 0);
91      setForceGroup(forceGroup);
92      logger.info(format("  Torsions:                          %10d", torsions.length));
93      logger.fine(format("   Force Group:                      %10d", forceGroup));
94    }
95  
96    /**
97     * Set the lambda torsion scale factor.
98     *
99     * @param lambdaTorsion The lambda torsion scale factor.
100    */
101   public void setLambdaTorsion(double lambdaTorsion) {
102     this.lambdaTorsion = lambdaTorsion;
103   }
104 
105   /**
106    * Convenience method to construct an OpenMM Torsion Force.
107    *
108    * @param openMMEnergy The OpenMM Energy instance that contains the torsions.
109    * @return A Torsion Force, or null if there are no torsions.
110    */
111   public static Force constructForce(OpenMMEnergy openMMEnergy) {
112     Torsion[] torsions = openMMEnergy.getTorsions();
113     if (torsions == null || torsions.length < 1) {
114       return null;
115     }
116     return new TorsionForce(openMMEnergy);
117   }
118 
119   /**
120    * Update the Torsion force.
121    *
122    * @param openMMEnergy The OpenMM Energy that contains the torsions.
123    */
124   public void updateForce(OpenMMEnergy openMMEnergy) {
125     // Check if this system has torsions.
126     Torsion[] torsions = openMMEnergy.getTorsions();
127     if (torsions == null || torsions.length < 1) {
128       return;
129     }
130 
131     int index = 0;
132     for (Torsion torsion : torsions) {
133       TorsionType torsionType = torsion.torsionType;
134       int nTerms = torsionType.phase.length;
135       int a1 = torsion.getAtom(0).getXyzIndex() - 1;
136       int a2 = torsion.getAtom(1).getXyzIndex() - 1;
137       int a3 = torsion.getAtom(2).getXyzIndex() - 1;
138       int a4 = torsion.getAtom(3).getXyzIndex() - 1;
139       for (int j = 0; j < nTerms; j++) {
140         double k = torsion.getTorsionScale() * torsionType.torsionUnit * torsionType.amplitude[j] * lambdaTorsion;
141         setTorsionParameters(index++, a1, a2, a3, a4, j + 1,
142             torsionType.phase[j] * OpenMM_RadiansPerDegree, OpenMM_KJPerKcal * k);
143       }
144       // Enforce 6-fold torsions since TorsionType instances can have different lengths
145       // when side-chain protonation changes.
146       if (manyBodyTitration) {
147         for (int j = nTerms; j < 6; j++) {
148           setTorsionParameters(index++, a1, a2, a3, a4, j + 1, 0.0, 0.0);
149         }
150       }
151     }
152     updateParametersInContext(openMMEnergy.getContext());
153   }
154 
155 }