src/gromacs/analysisdata/paralleloptions.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::AnalysisDataParallelOptions.
  38  *
  39  * \if internal
  40  * Implementation of this class is currently in datastorage.cpp.
  41  * \endif
  42  *
  43  * \author Teemu Murtola <teemu.murtola@gmail.com>
  44  * \inlibraryapi
  45  * \ingroup module_analysisdata
  46  */
  47 #ifndef GMX_ANALYSISDATA_PARALLELOPTIONS_H
  48 #define GMX_ANALYSISDATA_PARALLELOPTIONS_H
  49
  50 namespace gmx
  51 {
  52
  53 /*! \libinternal \brief
  54  * Parallelization options for analysis data objects.
  55  *
  56  * Methods in this class do not throw.
  57  *
  58  * \inlibraryapi
  59  * \ingroup module_analysisdata
  60  */
  61 class AnalysisDataParallelOptions
  62 {
  63     public:
  64         //! Constructs options for serial execution.
  65         AnalysisDataParallelOptions();
  66         /*! \brief
  67          * Constructs options for parallel execution with given number of
  68          * concurrent frames.
  69          *
  70          * \param[in] parallelizationFactor
  71          *      Number of frames that may be constructed concurrently.
  72          *      Must be >= 1.
  73          */
  74         explicit AnalysisDataParallelOptions(int parallelizationFactor);
  75
  76         //! Returns the number of frames that may be constructed concurrently.
  77         int parallelizationFactor() const { return parallelizationFactor_; }
  78
  79     private:
  80         int                     parallelizationFactor_;
  81 };
  82
  83 } // namespace gmx
  84
  85 #endif