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-2024.
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.RestraintTorsion;
43  import ffx.potential.bonded.Torsion;
44  import ffx.potential.parameters.TorsionType;
45  
46  import java.util.List;
47  import java.util.logging.Level;
48  import java.util.logging.Logger;
49  
50  import static edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_KJPerKcal;
51  import static edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_RadiansPerDegree;
52  import static java.lang.String.format;
53  
54  /**
55   * Restrain Torsions Force.
56   */
57  public class RestrainTorsionsForce extends PeriodicTorsionForce {
58  
59    private static final Logger logger = Logger.getLogger(RestrainTorsionsForce.class.getName());
60  
61    /**
62     * Restrain Torsion Force constructor.
63     *
64     * @param openMMEnergy The OpenMM Energy that contains the restraint-torsions.
65     */
66    public RestrainTorsionsForce(OpenMMEnergy openMMEnergy) {
67      List<RestraintTorsion> restraintTorsions = openMMEnergy.getRestrainTorsions();
68      if (restraintTorsions == null || restraintTorsions.isEmpty()) {
69        return;
70      }
71  
72      for (RestraintTorsion restraintTorsion : restraintTorsions) {
73        int a1 = restraintTorsion.getAtom(0).getXyzIndex() - 1;
74        int a2 = restraintTorsion.getAtom(1).getXyzIndex() - 1;
75        int a3 = restraintTorsion.getAtom(2).getXyzIndex() - 1;
76        int a4 = restraintTorsion.getAtom(3).getXyzIndex() - 1;
77        TorsionType torsionType = restraintTorsion.torsionType;
78        int nTerms = torsionType.phase.length;
79        for (int j = 0; j < nTerms; j++) {
80          addTorsion(a1, a2, a3, a4, j + 1,
81              torsionType.phase[j] * OpenMM_RadiansPerDegree,
82              OpenMM_KJPerKcal * torsionType.torsionUnit * torsionType.amplitude[j]);
83        }
84      }
85  
86      int forceGroup = openMMEnergy.getMolecularAssembly().getForceField().getInteger("RESTRAINT_TORSION_FORCE_GROUP", 0);
87      setForceGroup(forceGroup);
88      logger.log(Level.INFO, format("  Restraint-Torsions \t%6d\t\t%1d", restraintTorsions.size(), forceGroup));
89    }
90  
91    /**
92     * Convenience method to construct an OpenMM Torsion Force.
93     *
94     * @param openMMEnergy The OpenMM Energy instance that contains the torsions.
95     * @return A Torsion Force, or null if there are no torsions.
96     */
97    public static Force constructForce(OpenMMEnergy openMMEnergy) {
98      Torsion[] torsions = openMMEnergy.getTorsions();
99      if (torsions == null || torsions.length < 1) {
100       return null;
101     }
102     return new RestrainTorsionsForce(openMMEnergy);
103   }
104 
105   /**
106    * Update the Restraint-Torsion force.
107    *
108    * @param openMMEnergy The OpenMM Energy that contains the restraint-torsions.
109    */
110   public void updateForce(OpenMMEnergy openMMEnergy) {
111     // Check if this system has restraintTorsions.
112     List<RestraintTorsion> restraintTorsions = openMMEnergy.getRestrainTorsions();
113     if (restraintTorsions == null || restraintTorsions.isEmpty()) {
114       return;
115     }
116 
117     int index = 0;
118     for (RestraintTorsion restraintTorsion : restraintTorsions) {
119       TorsionType torsionType = restraintTorsion.torsionType;
120       int nTerms = torsionType.phase.length;
121       int a1 = restraintTorsion.getAtom(0).getXyzIndex() - 1;
122       int a2 = restraintTorsion.getAtom(1).getXyzIndex() - 1;
123       int a3 = restraintTorsion.getAtom(2).getXyzIndex() - 1;
124       int a4 = restraintTorsion.getAtom(3).getXyzIndex() - 1;
125       for (int j = 0; j < nTerms; j++) {
126         double forceConstant = OpenMM_KJPerKcal * torsionType.torsionUnit * torsionType.amplitude[j];
127         setTorsionParameters(index++, a1, a2, a3, a4, j + 1,
128             torsionType.phase[j] * OpenMM_RadiansPerDegree, forceConstant);
129       }
130     }
131     updateParametersInContext(openMMEnergy.getContext());
132   }
133 
134 }