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.ImproperTorsion;
43  import ffx.potential.parameters.ImproperTorsionType;
44  
45  import java.util.logging.Level;
46  import java.util.logging.Logger;
47  
48  import static edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_KJPerKcal;
49  import static edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_RadiansPerDegree;
50  import static java.lang.String.format;
51  
52  /**
53   * OpenMM Improper Torsion Force.
54   */
55  public class ImproperTorsionForce extends PeriodicTorsionForce {
56  
57    private static final Logger logger = Logger.getLogger(ImproperTorsionForce.class.getName());
58  
59    private double lambdaTorsion = 1.0;
60  
61    /**
62     * Create an OpenMM Improper Torsion Force.
63     *
64     * @param openMMEnergy The OpenMM Energy instance that contains the improper torsions.
65     */
66    public ImproperTorsionForce(OpenMMEnergy openMMEnergy) {
67      ImproperTorsion[] improperTorsions = openMMEnergy.getImproperTorsions();
68      if (improperTorsions == null || improperTorsions.length < 1) {
69        // Clean up the memory allocated by the OpenMMPeriodicTorsionForce constructor.
70        destroy();
71        return;
72      }
73  
74      for (ImproperTorsion improperTorsion : improperTorsions) {
75        int a1 = improperTorsion.getAtom(0).getXyzIndex() - 1;
76        int a2 = improperTorsion.getAtom(1).getXyzIndex() - 1;
77        int a3 = improperTorsion.getAtom(2).getXyzIndex() - 1;
78        int a4 = improperTorsion.getAtom(3).getXyzIndex() - 1;
79        ImproperTorsionType type = improperTorsion.improperType;
80        double forceConstant = OpenMM_KJPerKcal * type.impTorUnit * improperTorsion.scaleFactor * type.k;
81        addTorsion(a1, a2, a3, a4, type.periodicity, type.phase * OpenMM_RadiansPerDegree, forceConstant);
82      }
83  
84      int forceGroup = openMMEnergy.getMolecularAssembly().getForceField().getInteger("IMPROPER_TORSION_FORCE_GROUP", 0);
85      setForceGroup(forceGroup);
86      logger.info(format("  Improper Torsions:                 %10d", improperTorsions.length));
87      logger.fine(format("   Force Group:                      %10d", forceGroup));
88    }
89  
90    /**
91     * Set the lambda torsion scale factor.
92     *
93     * @param lambdaTorsion The lambda torsion scale factor.
94     */
95    public void setLambdaTorsion(double lambdaTorsion) {
96      this.lambdaTorsion = lambdaTorsion;
97    }
98  
99    /**
100    * Convenience method to construct an OpenMM Improper Torsion Force.
101    *
102    * @param openMMEnergy The OpenMM Energy instance that contains the improper torsions.
103    * @return An Improper Torsion Force, or null if there are no improper torsions.
104    */
105   public static Force constructForce(OpenMMEnergy openMMEnergy) {
106     ImproperTorsion[] improperTorsions = openMMEnergy.getImproperTorsions();
107     if (improperTorsions == null || improperTorsions.length < 1) {
108       return null;
109     }
110     return new ImproperTorsionForce(openMMEnergy);
111   }
112 
113   /**
114    * Update the Improper Torsion force.
115    *
116    * @param openMMEnergy The OpenMM Energy that contains the improper torsions.
117    */
118   public void updateForce(OpenMMEnergy openMMEnergy) {
119     ImproperTorsion[] improperTorsions = openMMEnergy.getImproperTorsions();
120     if (improperTorsions == null || improperTorsions.length < 1) {
121       return;
122     }
123 
124     int nImproperTorsions = improperTorsions.length;
125     for (int i = 0; i < nImproperTorsions; i++) {
126       ImproperTorsion improperTorsion = improperTorsions[i];
127       int a1 = improperTorsion.getAtom(0).getXyzIndex() - 1;
128       int a2 = improperTorsion.getAtom(1).getXyzIndex() - 1;
129       int a3 = improperTorsion.getAtom(2).getXyzIndex() - 1;
130       int a4 = improperTorsion.getAtom(3).getXyzIndex() - 1;
131       ImproperTorsionType type = improperTorsion.improperType;
132       double forceConstant = OpenMM_KJPerKcal * type.impTorUnit * improperTorsion.scaleFactor * type.k * lambdaTorsion;
133       setTorsionParameters(i, a1, a2, a3, a4, type.periodicity, type.phase * OpenMM_RadiansPerDegree, forceConstant);
134     }
135 
136     updateParametersInContext(openMMEnergy.getContext());
137   }
138 
139 }