src/programs/mdrun/tests/comparison_helpers.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 common to comparing either
  38  * energies or trajectories 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_COMPARISON_HELPERS_H
  44 #define GMX_PROGRAMS_MDRUN_TESTS_COMPARISON_HELPERS_H
  45
  46 namespace gmx
  47 {
  48
  49 namespace test
  50 {
  51
  52 /*! \internal
  53  * \brief Named struct indicating the max number of frames to be compared */
  54 struct MaxNumFrames
  55 {
  56     //! Explicit constructor
  57     explicit MaxNumFrames(unsigned int maxFrame) : maxFrame_(maxFrame) {}
  58
  59     //! Implicit conversion to int - struct can be used like underlying type
  60     operator unsigned int() const { return maxFrame_; }
  61
  62     //! Return a MaxNumFrames that will try to compare all frames
  63     [[nodiscard]] static MaxNumFrames compareAllFrames()
  64     {
  65         return MaxNumFrames(std::numeric_limits<decltype(maxFrame_)>::max());
  66     }
  67
  68 private:
  69     //! Internal value
  70     const unsigned int maxFrame_;
  71 };
  72
  73 } // namespace test
  74 } // namespace gmx
  75
  76 #endif