src/gromacs/legacyheaders/typedefs.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, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37
  38 #ifndef _typedefs_h
  39 #define _typedefs_h
  40
  41
  42 /* DEPRECATED! value for signaling unitialized variables */
  43 #define NOTSET -12345
  44
  45 #include <sys/types.h>
  46
  47 #include "types/simple.h"
  48 #include "types/enums.h"
  49 #include "types/block.h"
  50 #include "types/idef.h"
  51 #include "types/atoms.h"
  52 #include "../fileio/trx.h"
  53 #include "types/topology.h"
  54 #include "types/energy.h"
  55 #include "types/inputrec.h"
  56 #include "types/ishift.h"
  57 #include "types/nrnb.h"
  58 #include "types/nblist.h"
  59 #include "types/nbnxn_pairlist.h"
  60 #include "types/nsgrid.h"
  61 #include "types/forcerec.h"
  62 #include "types/fcdata.h"
  63 #include "types/mdatom.h"
  64 #include "types/ifunc.h"
  65 #include "types/group.h"
  66 #include "types/state.h"
  67 #include "types/shellfc.h"
  68 #include "types/constr.h"
  69 #include "types/oenv.h"
  70 #include "types/commrec_fwd.h"
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 /*
  77  * Memory (re)allocation can be VERY slow, especially with some
  78  * MPI libraries that replace the standard malloc and realloc calls.
  79  * To avoid slow memory allocation we use over_alloc to set the memory
  80  * allocation size for large data blocks. Since this scales the size
  81  * with a factor, we use log(n) realloc calls instead of n.
  82  * This can reduce allocation times from minutes to seconds.
  83  */
  84 /* This factor leads to 4 realloc calls to double the array size */
  85 #define OVER_ALLOC_FAC 1.19
  86
  87 void set_over_alloc_dd(gmx_bool set);
  88 /* Turns over allocation for variable size atoms/cg/top arrays on or off,
  89  * default is off.
  90  */
  91
  92 int over_alloc_dd(int n);
  93 /* Returns n when domain decomposition over allocation is off.
  94  * Returns OVER_ALLOC_FAC*n + 100 when over allocation in on.
  95  * This is to avoid frequent reallocation
  96  * during domain decomposition in mdrun.
  97  */
  98
  99 /* Over allocation for small data types: int, real etc. */
 100 #define over_alloc_small(n) (int)(OVER_ALLOC_FAC*(n) + 8000)
 101
 102 /* Over allocation for large data types: complex structs */
 103 #define over_alloc_large(n) (int)(OVER_ALLOC_FAC*(n) + 1000)
 104
 105 int gmx_int64_to_int(gmx_int64_t step, const char *warn);
 106 /* Convert a gmx_int64_t value to int.
 107  * If warn!=NULL a warning message will be written
 108  * to stderr when step does not fit in an int,
 109  * the first line is:
 110  * "WARNING during %s:", where warn is printed in %s.
 111  */
 112
 113 #define STEPSTRSIZE 22
 114
 115 char *gmx_step_str(gmx_int64_t i, char *buf);
 116 /* Prints a gmx_int64_t value in buf and returns the pointer to buf.
 117  * buf should be large enough to contain i: STEPSTRSIZE (22) chars.
 118  * When multiple gmx_int64_t values are printed in the same printf call,
 119  * be sure to call gmx_step_str with different buffers.
 120  */
 121
 122 /* Functions to initiate and delete structures *
 123  * These functions are defined in gmxlib/typedefs.c
 124  */
 125 void init_block(t_block *block);
 126 void init_blocka(t_blocka *block);
 127 void init_atom (t_atoms *at);
 128 void init_mtop(gmx_mtop_t *mtop);
 129 void init_top(t_topology *top);
 130 void init_inputrec(t_inputrec *ir);
 131 void init_energyhistory(energyhistory_t * enerhist);
 132 void done_energyhistory(energyhistory_t * enerhist);
 133 void init_gtc_state(t_state *state, int ngtc, int nnhpres, int nhchainlength);
 134 void init_state(t_state *state, int natoms, int ngtc, int nnhpres, int nhchainlength, int nlambda);
 135 t_state *serial_init_local_state(t_state *state_global);
 136 void init_df_history(df_history_t *dfhist, int nlambda);
 137 void done_df_history(df_history_t *dfhist);
 138 void copy_df_history(df_history_t * df_dest, df_history_t *df_source);
 139
 140 void copy_blocka(const t_blocka *src, t_blocka *dest);
 141
 142 void done_block(t_block *block);
 143 void done_blocka(t_blocka *block);
 144 void done_atom (t_atoms *at);
 145 void done_moltype(gmx_moltype_t *molt);
 146 void done_molblock(gmx_molblock_t *molb);
 147 void done_mtop(gmx_mtop_t *mtop, gmx_bool bDoneSymtab);
 148 void done_top(t_topology *top);
 149 void done_inputrec(t_inputrec *ir);
 150 void done_state(t_state *state);
 151
 152 void set_box_rel(t_inputrec *ir, t_state *state);
 153 /* Set state->box_rel used in mdrun to preserve the box shape */
 154
 155 void preserve_box_shape(t_inputrec *ir, matrix box_rel, matrix b);
 156 /* Preserve the box shape, b can be box or boxv */
 157
 158 void stupid_fill_block(t_block *grp, int natom, gmx_bool bOneIndexGroup);
 159 /* Fill a block structure with numbers identical to the index
 160  * (0, 1, 2, .. natom-1)
 161  * If bOneIndexGroup, then all atoms are  lumped in one index group,
 162  * otherwise there is one atom per index entry
 163  */
 164
 165 void stupid_fill_blocka(t_blocka *grp, int natom);
 166 /* Fill a block structure with numbers identical to the index
 167  * (0, 1, 2, .. natom-1)
 168  * There is one atom per index entry
 169  */
 170
 171 void init_t_atoms(t_atoms *atoms, int natoms, gmx_bool bPdbinfo);
 172 /* allocate memory for the arrays, set nr to natoms and nres to 0
 173  * set pdbinfo to NULL or allocate memory for it */
 174
 175 t_atoms *copy_t_atoms(t_atoms *src);
 176 /* copy an atoms struct from src to a new one */
 177
 178 void add_t_atoms(t_atoms *atoms, int natom_extra, int nres_extra);
 179 /* allocate extra space for more atoms and or residues */
 180
 181 void t_atoms_set_resinfo(t_atoms *atoms, int atom_ind, struct t_symtab *symtab,
 182                          const char *resname, int resnr, unsigned char ic,
 183                          int chainnum, char chainid);
 184 /* Set the residue name, number, insertion code and chain identifier
 185  * of atom index atom_ind.
 186  */
 187
 188 void free_t_atoms(t_atoms *atoms, gmx_bool bFreeNames);
 189 /* Free all the arrays and set the nr and nres to 0.
 190  * bFreeNames tells if to free the atom and residue name strings,
 191  * don't free them if they still need to be used in e.g. the topology struct.
 192  */
 193
 194 t_atoms *mtop2atoms(gmx_mtop_t *mtop);
 195 /* generate a t_atoms struct for the system from gmx_mtop_t */
 196
 197 real max_cutoff(real cutoff1, real cutoff2);
 198 /* Returns the maximum of the cut-off's, taking into account that 0=inf. */
 199
 200 #ifdef __cplusplus
 201 }
 202 #endif
 203
 204
 205 #endif  /* _typedefs_h */