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.CustomExternalForce;
41  import ffx.openmm.DoubleArray;
42  import ffx.openmm.Force;
43  import ffx.potential.bonded.Atom;
44  import ffx.potential.bonded.RestrainPosition;
45  import ffx.potential.terms.RestrainPositionPotentialEnergy;
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 edu.uiowa.jopenmm.OpenMMAmoebaLibrary.OpenMM_NmPerAngstrom;
52  import static java.lang.String.format;
53  
54  /**
55   * Restrain Positions Force.
56   */
57  public class RestrainPositionsForce extends CustomExternalForce {
58  
59    private static final Logger logger = Logger.getLogger(RestrainPositionsForce.class.getName());
60  
61    /**
62     * Restrain Positions Force constructor.
63     *
64     * @param restrainPositionPotentialEnergy RestrainPositionPotentialEnergy instance.
65     */
66    public RestrainPositionsForce(RestrainPositionPotentialEnergy restrainPositionPotentialEnergy) {
67      super(RestrainPositionPotentialEnergy.getRestrainPositionEnergyString());
68      RestrainPosition[] restrainPositions = restrainPositionPotentialEnergy.getRestrainPositionArray();
69      // Define per particle parameters.
70      addPerParticleParameter("k0");
71      addPerParticleParameter("x0");
72      addPerParticleParameter("y0");
73      addPerParticleParameter("z0");
74  
75      int nRestraints = restrainPositions.length;
76      double convert = OpenMM_KJPerKcal / (OpenMM_NmPerAngstrom * OpenMM_NmPerAngstrom);
77  
78      for (RestrainPosition restrainPosition : restrainPositions) {
79        double forceConstant = restrainPosition.getForceConstant() * convert;
80        Atom[] restrainPositionAtoms = restrainPosition.getAtoms();
81        int numAtoms = restrainPosition.getNumAtoms();
82        double[][] equilibriumCoordinates = restrainPosition.getEquilibriumCoordinates();
83        for (int i = 0; i < numAtoms; i++) {
84          equilibriumCoordinates[i][0] *= OpenMM_NmPerAngstrom;
85          equilibriumCoordinates[i][1] *= OpenMM_NmPerAngstrom;
86          equilibriumCoordinates[i][2] *= OpenMM_NmPerAngstrom;
87        }
88  
89        DoubleArray parameters = new DoubleArray(4);
90        for (int i = 0; i < numAtoms; i++) {
91          int index = restrainPositionAtoms[i].getXyzIndex() - 1;
92          parameters.set(0, forceConstant);
93          for (int j = 0; j < 3; j++) {
94            parameters.set(j + 1, equilibriumCoordinates[i][j]);
95          }
96          addParticle(index, parameters);
97        }
98        parameters.destroy();
99      }
100 
101     int forceGroup = restrainPositionPotentialEnergy.getForceGroup();
102     setForceGroup(forceGroup);
103     logger.log(Level.INFO, format("  Restrain Positions\t%6d\t\t%d", nRestraints, forceGroup));
104   }
105 
106   /**
107    * Add a Restrain-Position force to the OpenMM System.
108    */
109   public static Force constructForce(OpenMMEnergy openMMEnergy) {
110     RestrainPositionPotentialEnergy restrainPositionPotentialEnergy =
111         openMMEnergy.getRestrainPositionPotentialEnergy();
112     if (restrainPositionPotentialEnergy == null) {
113       return null;
114     }
115     return new RestrainPositionsForce(restrainPositionPotentialEnergy);
116   }
117 
118 }