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.CustomBondForce;
43  import ffx.potential.bonded.Atom;
44  import ffx.potential.bonded.RestrainDistance;
45  import ffx.potential.parameters.BondType;
46  
47  import java.util.List;
48  import java.util.logging.Level;
49  import java.util.logging.Logger;
50  
51  import static edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_KJPerKcal;
52  import static edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_NmPerAngstrom;
53  import static java.lang.String.format;
54  
55  /**
56   * Restrain Bonds Force.
57   */
58  public class RestrainBondsForce extends CustomBondForce {
59  
60    private static final Logger logger = Logger.getLogger(RestrainBondsForce.class.getName());
61  
62    /**
63     * Restrain Bond Force constructor.
64     *
65     * @param bondFunction The bond function.
66     * @param openMMEnergy The OpenMM Energy.
67     */
68    public RestrainBondsForce(BondType.BondFunction bondFunction, OpenMMEnergy openMMEnergy) {
69      super(bondFunction.toMathematicalForm());
70  
71      List<RestrainDistance> restrainDistances = openMMEnergy.getRestrainDistances(bondFunction);
72      if (restrainDistances == null || restrainDistances.isEmpty()) {
73        destroy();
74        return;
75      }
76  
77      addPerBondParameter("k");
78      addPerBondParameter("r0");
79      if (bondFunction.hasFlatBottom()) {
80        addPerBondParameter("fb");
81      }
82  
83      BondType bondType = restrainDistances.getFirst().bondType;
84      switch (bondFunction) {
85        case QUARTIC, FLAT_BOTTOM_QUARTIC -> {
86          addGlobalParameter("cubic", bondType.cubic / OpenMM_NmPerAngstrom);
87          addGlobalParameter("quartic", bondType.quartic / (OpenMM_NmPerAngstrom * OpenMM_NmPerAngstrom));
88        }
89      }
90  
91      // OpenMM's HarmonicBondForce class uses k, not 1/2*k as does FFX.
92      double forceConvert = 2.0 * OpenMM_KJPerKcal / (OpenMM_NmPerAngstrom * OpenMM_NmPerAngstrom);
93      DoubleArray parameters = new DoubleArray(0);
94      for (RestrainDistance restrainDistance : restrainDistances) {
95        bondType = restrainDistance.bondType;
96        double forceConstant = bondType.forceConstant * bondType.bondUnit * forceConvert;
97        double distance = bondType.distance * OpenMM_NmPerAngstrom;
98        Atom[] atoms = restrainDistance.getAtomArray();
99        int i1 = atoms[0].getXyzIndex() - 1;
100       int i2 = atoms[1].getXyzIndex() - 1;
101       parameters.append(forceConstant);
102       parameters.append(distance);
103       if (bondFunction.hasFlatBottom()) {
104         parameters.append(bondType.flatBottomRadius * OpenMM_NmPerAngstrom);
105       }
106       addBond(i1, i2, parameters);
107       parameters.destroy();
108     }
109     parameters.destroy();
110 
111     int forceGroup = openMMEnergy.getMolecularAssembly().getForceField().getInteger("BOND_RESTRAINT_FORCE_GROUP", 0);
112     setForceGroup(forceGroup);
113     logger.log(Level.INFO, format("  Restraint bonds force \t%6d\t%d", restrainDistances.size(), forceGroup));
114   }
115 
116   /**
117    * Add a Restrain-Bond force to the OpenMM System.
118    *
119    * @param bondFunction The bond function.
120    * @param openMMEnergy The OpenMM Energy.
121    */
122   public static Force constructForce(BondType.BondFunction bondFunction, OpenMMEnergy openMMEnergy) {
123     List<RestrainDistance> restrainDistances = openMMEnergy.getRestrainDistances(bondFunction);
124     if (restrainDistances == null || restrainDistances.isEmpty()) {
125       return null;
126     }
127     return new RestrainBondsForce(bondFunction, openMMEnergy);
128   }
129 }