src/programs/mdrun/tests/trajectorycomparison.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019,2020, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 /*! \internal \file
  37  * \brief Declares types and functions for comparing trajectories
  38  * produced by mdrun.
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  * \ingroup module_mdrun_integration_tests
  42  */
  43 #ifndef GMX_PROGRAMS_MDRUN_TESTS_TRAJECTORYCOMPARISON_H
  44 #define GMX_PROGRAMS_MDRUN_TESTS_TRAJECTORYCOMPARISON_H
  45
  46 #include "testutils/testasserts.h"
  47
  48 #include "comparison_helpers.h"
  49
  50 namespace gmx
  51 {
  52
  53 class TrajectoryFrame;
  54
  55 namespace test
  56 {
  57
  58 /*! \internal
  59  * \brief Helper struct for testing different trajectory components with different tolerances. */
  60 struct TrajectoryTolerances
  61 {
  62     /*!@{*/
  63     /*! \brief Tolerances for reproduction of different quantities. */
  64     FloatingPointTolerance box, coordinates, velocities, forces;
  65     /*!@}*/
  66 };
  67
  68 //! Enumeration controlling how data within trajectory frames are compared
  69 enum class ComparisonConditions : int
  70 {
  71     CompareIfBothFound,
  72     NoComparison,
  73     MustCompare,
  74     CompareIfReferenceFound,
  75     CompareIfTestFound,
  76     Count
  77 };
  78
  79 /*! \internal
  80  * \brief Helper struct to specify the expected behaviour of compareFrames().
  81  *
  82  * By default, nothing is required to be compared, but the comparer will
  83  * compare what it can with the frames it is given.
  84  *
  85  * Handling PBC refers to putting all the atoms in the simulation box,
  86  * which requires that both the PBC type and a simulation box are
  87  * available from the trajectory frame. */
  88 struct TrajectoryFrameMatchSettings
  89 {
  90     //! Whether boxes must be compared.
  91     bool mustCompareBox = false;
  92     //! Whether PBC will be handled if it can be handled.
  93     bool handlePbcIfPossible = true;
  94     //! Whether PBC handling must occur for a valid comparison.
  95     bool requirePbcHandling = false;
  96     //! Whether position coordinates must be compared.
  97     ComparisonConditions coordinatesComparison = ComparisonConditions::CompareIfBothFound;
  98     //! Whether velocities must be compared.
  99     ComparisonConditions velocitiesComparison = ComparisonConditions::CompareIfBothFound;
 100     //! Whether forces must be compared.
 101     ComparisonConditions forcesComparison = ComparisonConditions::CompareIfBothFound;
 102     //! Which frames will be compared
 103     FramesToCompare framesToCompare = FramesToCompare::AllFrames;
 104 };
 105
 106 /*! \internal
 107  * \brief Function object to compare the fields of the two frames for
 108  * equality given the \c matchSettings_ and \c tolerances_.
 109  *
 110  * The two frames are required to have valid and matching values for
 111  * time and step. According to \c matchSettings_, box, position coordinates,
 112  * velocities and/or forces will be compared between frames, using the
 113  * \c tolerances_. Comparisons will only occur when both frames have
 114  * the requisite data, and will be expected to be equal within the
 115  * matching component of \c tolerances_. If a comparison fails, a
 116  * GoogleTest expectation failure will be given. If a comparison is
 117  * required by \c matchSettings_ but cannot be done because either (or
 118  * both) frames lack the requisite data, descriptive expectation
 119  * failures will be given. */
 120 class TrajectoryComparison
 121 {
 122 public:
 123     //! Defaults for trajectory comparisons
 124     static const TrajectoryTolerances s_defaultTrajectoryTolerances;
 125     //! Constructor
 126     TrajectoryComparison(const TrajectoryFrameMatchSettings& matchSettings,
 127                          const TrajectoryTolerances&         tolerances);
 128     /*! \brief Compare reference with test given the \c
 129      * matchSettings_ within \c tolerances_ */
 130     void operator()(const TrajectoryFrame& reference, const TrajectoryFrame& test) const;
 131
 132 private:
 133     //! Specifies expected behavior in comparisons
 134     TrajectoryFrameMatchSettings matchSettings_;
 135     //! Trajectory fields to match with given tolerances.
 136     TrajectoryTolerances tolerances_;
 137     /*! \brief Whether the first frame has been compared yet
 138      *
 139      * This field is mutable because the need to update the flag
 140      * after the first frame is merely an implementation detail,
 141      * rather than a proper change of internal state triggered
 142      * by the caller. */
 143     mutable bool firstFrameHasBeenCompared_ = false;
 144 };
 145
 146 } // namespace test
 147 } // namespace gmx
 148
 149 #endif