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.DoubleArray;
41  import ffx.openmm.Force;
42  import ffx.openmm.IntArray;
43  import ffx.openmm.CustomCompoundBondForce;
44  import ffx.potential.bonded.OutOfPlaneBend;
45  import ffx.potential.parameters.OutOfPlaneBendType;
46  
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 java.lang.String.format;
52  
53  /**
54   * OpenMM Out-of-Plane Bend Force.
55   */
56  public class OutOfPlaneBendForce extends CustomCompoundBondForce {
57  
58    private static final Logger logger = Logger.getLogger(OutOfPlaneBendForce.class.getName());
59  
60    /**
61     * Create an Out-of-Plane Bend Force.
62     *
63     * @param openMMEnergy The OpenMM Energy instance that contains the out-of-plane bends.
64     */
65    public OutOfPlaneBendForce(OpenMMEnergy openMMEnergy) {
66      super(4, openMMEnergy.getOutOfPlaneEnergyString());
67      OutOfPlaneBend[] outOfPlaneBends = openMMEnergy.getOutOfPlaneBends();
68      if (outOfPlaneBends == null || outOfPlaneBends.length < 1) {
69        return;
70      }
71  
72      addPerBondParameter("k");
73      setName("OutOfPlaneBend");
74  
75      IntArray particles = new IntArray(0);
76      DoubleArray parameters = new DoubleArray(0);
77      for (OutOfPlaneBend outOfPlaneBend : outOfPlaneBends) {
78        OutOfPlaneBendType outOfPlaneBendType = outOfPlaneBend.outOfPlaneBendType;
79        int i1 = outOfPlaneBend.getAtom(0).getXyzIndex() - 1;
80        int i2 = outOfPlaneBend.getAtom(1).getXyzIndex() - 1;
81        int i3 = outOfPlaneBend.getAtom(2).getXyzIndex() - 1;
82        int i4 = outOfPlaneBend.getAtom(3).getXyzIndex() - 1;
83        double k = OpenMM_KJPerKcal * outOfPlaneBendType.forceConstant * outOfPlaneBendType.opBendUnit;
84        particles.append(i1);
85        particles.append(i2);
86        particles.append(i3);
87        particles.append(i4);
88        parameters.append(k);
89        addBond(particles, parameters);
90        particles.resize(0);
91        parameters.resize(0);
92      }
93      particles.destroy();
94      parameters.destroy();
95      int forceGroup = openMMEnergy.getMolecularAssembly().getForceField().getInteger("OUT_OF_PLANE_BEND_FORCE_GROUP", 0);
96      setForceGroup(forceGroup);
97      logger.log(Level.INFO, format("  Out-of-Plane Bends \t%6d\t\t%1d", outOfPlaneBends.length, forceGroup));
98    }
99  
100   /**
101    * Convenience method to construct an OpenMM Out-of-Plane Bend Force.
102    *
103    * @param openMMEnergy The OpenMM Energy instance that contains the out-of-plane bends.
104    * @return An OpenMM Out-of-Plane Bend Force, or null if there are no out-of-plane bends.
105    */
106   public static Force constructForce(OpenMMEnergy openMMEnergy) {
107     OutOfPlaneBend[] outOfPlaneBends = openMMEnergy.getOutOfPlaneBends();
108     if (outOfPlaneBends == null || outOfPlaneBends.length < 1) {
109       return null;
110     }
111     return new OutOfPlaneBendForce(openMMEnergy);
112   }
113 
114   /**
115    * Update an existing angle force for the OpenMM System.
116    *
117    * @param openMMEnergy The OpenMM Energy instance that contains the angles.
118    */
119   public void updateForce(OpenMMEnergy openMMEnergy) {
120     OutOfPlaneBend[] outOfPlaneBends = openMMEnergy.getOutOfPlaneBends();
121     if (outOfPlaneBends == null || outOfPlaneBends.length < 1) {
122       return;
123     }
124 
125     IntArray particles = new IntArray(0);
126     DoubleArray parameters = new DoubleArray(0);
127     int index = 0;
128     for (OutOfPlaneBend outOfPlaneBend : outOfPlaneBends) {
129       OutOfPlaneBendType outOfPlaneBendType = outOfPlaneBend.outOfPlaneBendType;
130       int i1 = outOfPlaneBend.getAtom(0).getXyzIndex() - 1;
131       int i2 = outOfPlaneBend.getAtom(1).getXyzIndex() - 1;
132       int i3 = outOfPlaneBend.getAtom(2).getXyzIndex() - 1;
133       int i4 = outOfPlaneBend.getAtom(3).getXyzIndex() - 1;
134       double k = OpenMM_KJPerKcal * outOfPlaneBendType.forceConstant * outOfPlaneBendType.opBendUnit;
135       particles.append(i1);
136       particles.append(i2);
137       particles.append(i3);
138       particles.append(i4);
139       parameters.append(k);
140       setBondParameters(index++, particles, parameters);
141       particles.resize(0);
142       parameters.resize(0);
143     }
144     particles.destroy();
145     parameters.destroy();
146 
147     updateParametersInContext(openMMEnergy.getContext());
148   }
149 }