Added basic tests for gmx msd
authorKevin Boyd <kevin.boyd@uconn.edu>
Sun, 16 Sep 2018 18:42:29 +0000 (14:42 -0400)
committerMark Abraham <mark.j.abraham@gmail.com>
Mon, 17 Sep 2018 07:36:07 +0000 (09:36 +0200)
Change-Id: I35d765d9a68d4723bf0a968d07453a268ed4e78a

src/gromacs/gmxana/tests/CMakeLists.txt
src/gromacs/gmxana/tests/gmx_msd.cpp [new file with mode: 0644]
src/gromacs/gmxana/tests/msd.ndx [new file with mode: 0644]
src/gromacs/gmxana/tests/msd_coords.gro [new file with mode: 0644]
src/gromacs/gmxana/tests/msd_traj.xtc [new file with mode: 0644]
src/gromacs/gmxana/tests/refdata/MsdTest_oneDimensionalDiffusion.xml [new file with mode: 0644]
src/gromacs/gmxana/tests/refdata/MsdTest_threeDimensionalDiffusion.xml [new file with mode: 0644]
src/gromacs/gmxana/tests/refdata/MsdTest_twoDimensionalDiffusion.xml [new file with mode: 0644]

index 65a7b212b95c741dd13cc5201b9065e91c72de59..e8db2e4fc21cdc001bdcbbc935b7d53ce339abb8 100644 (file)
@@ -39,5 +39,6 @@ gmx_add_gtest_executable(
     entropy.cpp
     gmx_traj.cpp
     gmx_trjconv.cpp
+    gmx_msd.cpp
     )
 gmx_register_gtest_test(GmxAnaTest ${exename} INTEGRATION_TEST)
diff --git a/src/gromacs/gmxana/tests/gmx_msd.cpp b/src/gromacs/gmxana/tests/gmx_msd.cpp
new file mode 100644 (file)
index 0000000..43e85be
--- /dev/null
@@ -0,0 +1,116 @@
+/*
+ * This file is part of the GROMACS molecular simulation package.
+ *
+ * Copyright (c) 2018, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
+ *
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
+ *
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
+ *
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
+ *
+ * To help us fund GROMACS development, we humbly ask that you cite
+ * the research papers on the package. Check out http://www.gromacs.org.
+ */
+/*! \internal \file
+ * \brief
+ * Tests for gmx msd.
+ *
+ * \author Kevin Boyd <kevin.boyd@uconn.edu>
+ */
+
+#include "gmxpre.h"
+
+#include "gromacs/gmxana/gmx_ana.h"
+#include "gromacs/utility/futil.h"
+#include "gromacs/utility/textreader.h"
+
+#include "testutils/cmdlinetest.h"
+#include "testutils/refdata.h"
+#include "testutils/testfilemanager.h"
+#include "testutils/textblockmatchers.h"
+#include "testutils/xvgtest.h"
+
+namespace
+{
+
+using gmx::test::CommandLine;
+using gmx::test::XvgMatch;
+
+class MsdTest : public gmx::test::CommandLineTestBase
+{
+    public:
+        MsdTest()
+        {
+            setOutputFile("-o", "msd.xvg", XvgMatch());
+            setInputFile("-f", "msd_traj.xtc");
+            setInputFile("-s", "msd_coords.gro");
+            setInputFile("-n", "msd.ndx");
+        }
+
+        void runTest(const CommandLine &args)
+        {
+            CommandLine &cmdline = commandLine();
+            cmdline.merge(args);
+            ASSERT_EQ(0, gmx_msd(cmdline.argc(), cmdline.argv()));
+            checkOutputFiles();
+        }
+};
+
+/* msd_traj.xtc contains a 10 frame (1 ps per frame) simulation
+ * containing 3 atoms, with different starting positions but identical
+ * displacements. The displacements are calculated to yield the following
+ * diffusion coefficients when lag is calculated ONLY FROM TIME 0
+ * D_x = 8 * 10 ^ -5 cm^2 /s, D_y = 4 * 10^ -5 cm^2 /s , D_z = 0
+ *
+ * To test for these results, -trestart is set to a larger value than the
+ * total simulation length, so that only lag 0 is calculated
+ */
+
+// for 3D, (8 + 4 + 0) / 3 should yield 4 cm^2 / s
+TEST_F(MsdTest, threeDimensionalDiffusion)
+{
+    const char *const cmdline[] = {
+        "msd", "-mw", "no", "-trestart", "200",
+    };
+    runTest(CommandLine(cmdline));
+}
+
+// for lateral z, (8 + 4) / 2 should yield 6 cm^2 /s
+TEST_F(MsdTest, twoDimensionalDiffusion)
+{
+    const char *const cmdline[] = {
+        "msd", "-mw", "no", "-trestart", "200", "-lateral", "z"
+    };
+    runTest(CommandLine(cmdline));
+}
+
+// for type x, should yield 8 cm^2 / s
+TEST_F(MsdTest, oneDimensionalDiffusion)
+{
+    const char *const cmdline[] = {
+        "msd", "-mw", "no", "-trestart", "200", "-type", "x"
+    };
+    runTest(CommandLine(cmdline));
+}
+} //namespace
diff --git a/src/gromacs/gmxana/tests/msd.ndx b/src/gromacs/gmxana/tests/msd.ndx
new file mode 100644 (file)
index 0000000..ec955c4
--- /dev/null
@@ -0,0 +1,2 @@
+[ particles ]
+1 2 3
diff --git a/src/gromacs/gmxana/tests/msd_coords.gro b/src/gromacs/gmxana/tests/msd_coords.gro
new file mode 100644 (file)
index 0000000..294f9bc
--- /dev/null
@@ -0,0 +1,6 @@
+msd_beads
+    3
+    1A        A    1   2.167   1.833   1.500
+    2A        A    2   0.000   0.000   0.000
+    3A        A    3   3.167   3.833   4.500
+   5.00000   5.00000   5.00000
diff --git a/src/gromacs/gmxana/tests/msd_traj.xtc b/src/gromacs/gmxana/tests/msd_traj.xtc
new file mode 100644 (file)
index 0000000..28bb267
Binary files /dev/null and b/src/gromacs/gmxana/tests/msd_traj.xtc differ
diff --git a/src/gromacs/gmxana/tests/refdata/MsdTest_oneDimensionalDiffusion.xml b/src/gromacs/gmxana/tests/refdata/MsdTest_oneDimensionalDiffusion.xml
new file mode 100644 (file)
index 0000000..4ba6e24
--- /dev/null
@@ -0,0 +1,68 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="referencedata.xsl"?>
+<ReferenceData>
+  <OutputFiles Name="Files">
+    <File Name="-o">
+      <XvgLegend Name="Legend">
+        <String Name="XvgLegend"><![CDATA[
+title "Mean Square Displacement"
+xaxis  label "Time (ps)"
+yaxis  label "MSD (nm\S2\N)"
+TYPE xy
+]]></String>
+      </XvgLegend>
+      <XvgData Name="Data">
+        <Sequence Name="Row0">
+          <Int Name="Length">2</Int>
+          <Real>0</Real>
+          <Real>0</Real>
+        </Sequence>
+        <Sequence Name="Row1">
+          <Int Name="Length">2</Int>
+          <Real>1</Real>
+          <Real>0.016</Real>
+        </Sequence>
+        <Sequence Name="Row2">
+          <Int Name="Length">2</Int>
+          <Real>2</Real>
+          <Real>0.032</Real>
+        </Sequence>
+        <Sequence Name="Row3">
+          <Int Name="Length">2</Int>
+          <Real>3</Real>
+          <Real>0.048</Real>
+        </Sequence>
+        <Sequence Name="Row4">
+          <Int Name="Length">2</Int>
+          <Real>4</Real>
+          <Real>0.064</Real>
+        </Sequence>
+        <Sequence Name="Row5">
+          <Int Name="Length">2</Int>
+          <Real>5</Real>
+          <Real>0.08</Real>
+        </Sequence>
+        <Sequence Name="Row6">
+          <Int Name="Length">2</Int>
+          <Real>6</Real>
+          <Real>0.096</Real>
+        </Sequence>
+        <Sequence Name="Row7">
+          <Int Name="Length">2</Int>
+          <Real>7</Real>
+          <Real>0.112</Real>
+        </Sequence>
+        <Sequence Name="Row8">
+          <Int Name="Length">2</Int>
+          <Real>8</Real>
+          <Real>0.128</Real>
+        </Sequence>
+        <Sequence Name="Row9">
+          <Int Name="Length">2</Int>
+          <Real>9</Real>
+          <Real>0.144</Real>
+        </Sequence>
+      </XvgData>
+    </File>
+  </OutputFiles>
+</ReferenceData>
diff --git a/src/gromacs/gmxana/tests/refdata/MsdTest_threeDimensionalDiffusion.xml b/src/gromacs/gmxana/tests/refdata/MsdTest_threeDimensionalDiffusion.xml
new file mode 100644 (file)
index 0000000..5f04b78
--- /dev/null
@@ -0,0 +1,68 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="referencedata.xsl"?>
+<ReferenceData>
+  <OutputFiles Name="Files">
+    <File Name="-o">
+      <XvgLegend Name="Legend">
+        <String Name="XvgLegend"><![CDATA[
+title "Mean Square Displacement"
+xaxis  label "Time (ps)"
+yaxis  label "MSD (nm\S2\N)"
+TYPE xy
+]]></String>
+      </XvgLegend>
+      <XvgData Name="Data">
+        <Sequence Name="Row0">
+          <Int Name="Length">2</Int>
+          <Real>0</Real>
+          <Real>0</Real>
+        </Sequence>
+        <Sequence Name="Row1">
+          <Int Name="Length">2</Int>
+          <Real>1</Real>
+          <Real>0.024</Real>
+        </Sequence>
+        <Sequence Name="Row2">
+          <Int Name="Length">2</Int>
+          <Real>2</Real>
+          <Real>0.048</Real>
+        </Sequence>
+        <Sequence Name="Row3">
+          <Int Name="Length">2</Int>
+          <Real>3</Real>
+          <Real>0.072</Real>
+        </Sequence>
+        <Sequence Name="Row4">
+          <Int Name="Length">2</Int>
+          <Real>4</Real>
+          <Real>0.096</Real>
+        </Sequence>
+        <Sequence Name="Row5">
+          <Int Name="Length">2</Int>
+          <Real>5</Real>
+          <Real>0.12</Real>
+        </Sequence>
+        <Sequence Name="Row6">
+          <Int Name="Length">2</Int>
+          <Real>6</Real>
+          <Real>0.144</Real>
+        </Sequence>
+        <Sequence Name="Row7">
+          <Int Name="Length">2</Int>
+          <Real>7</Real>
+          <Real>0.168</Real>
+        </Sequence>
+        <Sequence Name="Row8">
+          <Int Name="Length">2</Int>
+          <Real>8</Real>
+          <Real>0.192</Real>
+        </Sequence>
+        <Sequence Name="Row9">
+          <Int Name="Length">2</Int>
+          <Real>9</Real>
+          <Real>0.216</Real>
+        </Sequence>
+      </XvgData>
+    </File>
+  </OutputFiles>
+</ReferenceData>
diff --git a/src/gromacs/gmxana/tests/refdata/MsdTest_twoDimensionalDiffusion.xml b/src/gromacs/gmxana/tests/refdata/MsdTest_twoDimensionalDiffusion.xml
new file mode 100644 (file)
index 0000000..5f04b78
--- /dev/null
@@ -0,0 +1,68 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="referencedata.xsl"?>
+<ReferenceData>
+  <OutputFiles Name="Files">
+    <File Name="-o">
+      <XvgLegend Name="Legend">
+        <String Name="XvgLegend"><![CDATA[
+title "Mean Square Displacement"
+xaxis  label "Time (ps)"
+yaxis  label "MSD (nm\S2\N)"
+TYPE xy
+]]></String>
+      </XvgLegend>
+      <XvgData Name="Data">
+        <Sequence Name="Row0">
+          <Int Name="Length">2</Int>
+          <Real>0</Real>
+          <Real>0</Real>
+        </Sequence>
+        <Sequence Name="Row1">
+          <Int Name="Length">2</Int>
+          <Real>1</Real>
+          <Real>0.024</Real>
+        </Sequence>
+        <Sequence Name="Row2">
+          <Int Name="Length">2</Int>
+          <Real>2</Real>
+          <Real>0.048</Real>
+        </Sequence>
+        <Sequence Name="Row3">
+          <Int Name="Length">2</Int>
+          <Real>3</Real>
+          <Real>0.072</Real>
+        </Sequence>
+        <Sequence Name="Row4">
+          <Int Name="Length">2</Int>
+          <Real>4</Real>
+          <Real>0.096</Real>
+        </Sequence>
+        <Sequence Name="Row5">
+          <Int Name="Length">2</Int>
+          <Real>5</Real>
+          <Real>0.12</Real>
+        </Sequence>
+        <Sequence Name="Row6">
+          <Int Name="Length">2</Int>
+          <Real>6</Real>
+          <Real>0.144</Real>
+        </Sequence>
+        <Sequence Name="Row7">
+          <Int Name="Length">2</Int>
+          <Real>7</Real>
+          <Real>0.168</Real>
+        </Sequence>
+        <Sequence Name="Row8">
+          <Int Name="Length">2</Int>
+          <Real>8</Real>
+          <Real>0.192</Real>
+        </Sequence>
+        <Sequence Name="Row9">
+          <Int Name="Length">2</Int>
+          <Real>9</Real>
+          <Real>0.216</Real>
+        </Sequence>
+      </XvgData>
+    </File>
+  </OutputFiles>
+</ReferenceData>