src/gromacs/topology/forcefieldparameters.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2018 by the GROMACS development team.
   7  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #ifndef GMX_TOPOLOGY_FORCEFIELDPARAMETERS_H
  39 #define GMX_TOPOLOGY_FORCEFIELDPARAMETERS_H
  40
  41 #include <cstdio>
  42
  43 #include <vector>
  44
  45 #include "gromacs/topology/idef.h"
  46 #include "gromacs/utility/basedefinitions.h"
  47 #include "gromacs/utility/gmxassert.h"
  48 #include "gromacs/utility/real.h"
  49
  50 /*! \brief Struct that holds all force field parameters for the simulated system */
  51 struct gmx_ffparams_t
  52 {
  53     /*! \brief Returns the number of function types, which matches the number of elements in iparams */
  54     int numTypes() const
  55     {
  56         GMX_ASSERT(iparams.size() == functype.size(), "Parameters and function types go together");
  57
  58         return static_cast<int>(functype.size());
  59     }
  60
  61     /* TODO: Consider merging functype and iparams, either by storing
  62      *       the functype in t_iparams or by putting both in a single class.
  63      */
  64     int                     atnr = 0;    /**< The number of non-bonded atom types */
  65     std::vector<t_functype> functype;    /**< The function type per type */
  66     std::vector<t_iparams>  iparams;     /**< Force field parameters per type */
  67     double                  reppow  = 0; /**< The repulsion power for VdW: C12*r^-reppow   */
  68     real                    fudgeQQ = 0; /**< The scaling factor for Coulomb 1-4: f*q1*q2  */
  69     gmx_cmap_t              cmap_grid;   /**< The dihedral correction maps                 */
  70 };
  71
  72 void pr_ffparams(FILE* fp, int indent, const char* title, const gmx_ffparams_t* ffparams, gmx_bool bShowNumbers);
  73
  74 #endif