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.algorithms.groovy;
39  
40  import static org.junit.Assert.assertEquals;
41  
42  import ffx.algorithms.dynamics.MolecularDynamics;
43  import ffx.algorithms.misc.AlgorithmsTest;
44  import java.util.Arrays;
45  import java.util.Collection;
46  import org.junit.Test;
47  import org.junit.runner.RunWith;
48  import org.junit.runners.Parameterized;
49  import org.junit.runners.Parameterized.Parameters;
50  
51  /** @author Hernan V Bernabe */
52  @RunWith(Parameterized.class)
53  public class DynamicsNVETest extends AlgorithmsTest {
54  
55    private String info;
56    private String filename;
57    private double startingTotalEnergy;
58    private double endKineticEnergy;
59    private double endPotentialEnergy;
60    private double endTotalEnergy;
61    private double tolerance = 0.1;
62  
63    public DynamicsNVETest(
64        String info,
65        String filename,
66        double startingTotalEnergy,
67        double endKineticEnergy,
68        double endPotentialEnergy,
69        double endTotalEnergy) {
70      this.info = info;
71      this.filename = filename;
72      this.startingTotalEnergy = startingTotalEnergy;
73      this.endKineticEnergy = endKineticEnergy;
74      this.endPotentialEnergy = endPotentialEnergy;
75      this.endTotalEnergy = endTotalEnergy;
76    }
77  
78    @Parameters
79    public static Collection<Object[]> data() {
80      return Arrays.asList(
81          new Object[][] {
82              {
83                  "Acetamide Peptide NVE", // info
84                  "acetamide_NVE.xyz", // filename
85                  -25.1958, // startingTotalEnergy
86                  4.5625, // endKineticEnergy
87                  -29.8043, // endPotentialEnergy
88                  -25.2418 // endTotalEnergy
89              }
90          });
91    }
92  
93    @Test
94    public void testDynamicsHelp() {
95      // Set-up the input arguments for the script.
96      String[] args = {"-h"};
97      binding.setVariable("args", args);
98  
99      // Construct and evaluate the script.
100     Dynamics dynamics = new Dynamics(binding).run();
101     algorithmsScript = dynamics;
102   }
103 
104   @Test
105   public void testDynamicsNVE() {
106 
107     // Set-up the input arguments for the script.
108     String[] args = {
109         "-n", "10",
110         "-t", "298.15",
111         "-i", "VelocityVerlet",
112         "-b", "Adiabatic",
113         "-r", "0.001",
114         getResourcePath(filename)
115     };
116     binding.setVariable("args", args);
117 
118     // Construct and evaluate the script.
119     Dynamics dynamics = new Dynamics(binding).run();
120     algorithmsScript = dynamics;
121 
122     MolecularDynamics molDyn = dynamics.getMolecularDynamics();
123 
124     // Assert that energy is conserved at the end of the dynamics trajectory.
125     assertEquals(
126         info + " Final kinetic energy", endKineticEnergy, molDyn.getKineticEnergy(), tolerance);
127     assertEquals(
128         info + " Final potential energy", endPotentialEnergy, molDyn.getPotentialEnergy(),
129         tolerance);
130     assertEquals(
131         info + " Final total energy", startingTotalEnergy, molDyn.getTotalEnergy(), tolerance);
132   }
133 }