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