Merge branch release-5-1
[alexxy/gromacs.git] / src / gromacs / listed-forces / listed-internal.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2014,2015, 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 /*! \internal \file
36  *
37  * \brief This file contains declarations for functions needed
38  * internally by the module.
39  *
40  * \author Mark Abraham <mark.j.abraham@gmail.com>
41  * \ingroup module_listed-forces
42  */
43 #ifndef GMX_LISTED_FORCES_LISTED_INTERNAL_H
44 #define GMX_LISTED_FORCES_LISTED_INTERNAL_H
45
46 #include "gromacs/legacyheaders/types/forcerec.h"
47 #include "gromacs/math/vectypes.h"
48 #include "gromacs/topology/idef.h"
49 #include "gromacs/utility/bitmask.h"
50
51 /*! \internal \brief struct with output for bonded forces, used per thread */
52 typedef struct
53 {
54     rvec             *f;            /**< Force array */
55     int               f_nalloc;     /**< Allocation size of f */
56     gmx_bitmask_t     red_mask;     /**< Mask for marking which parts of f are filled */
57     rvec             *fshift;       /**< Shift force array, size SHIFTS */
58     real              ener[F_NRE];  /**< Energy array */
59     gmx_grppairener_t grpp;         /**< Group pair energy data for pairs */
60     real              dvdl[efptNR]; /**< Free-energy dV/dl output */
61 }
62 f_thread_t;
63
64 /*! \internal \brief struct contain all data for bonded force threading */
65 struct bonded_threading_t
66 {
67     /* Thread local force and energy data */
68     int         nthreads;   /**< Number of threads to be used for bondeds */
69     int         red_ashift; /**< Size of force reduction blocks in bits */
70     int         red_nblock; /**< The number of force blocks to reduce */
71     f_thread_t *f_t;        /**< Force/enegry data per thread, size nthreads */
72
73     /* There are two different ways to distribute the bonded force calculation
74      * over the threads. We dedice which to use based on the number of threads.
75      */
76     int bonded_max_nthread_uniform; /**< Maximum thread count for uniform distribution of bondeds over threads */
77 };
78
79
80 /*! \brief Returns the global topology atom number belonging to local
81  * atom index i.
82  *
83  * This function is intended for writing ascii output and returns atom
84  * numbers starting at 1.  When global_atom_index=NULL returns i+1.
85  */
86 int
87 glatnr(int *global_atom_index, int i);
88
89 #endif