src/gromacs/legacyheaders/checkpoint.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _checkpoint_h
  37 #define _checkpoint_h
  38
  39
  40 #include "typedefs.h"
  41 #include "../fileio/gmxfio.h"
  42 #include "../fileio/filenm.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /* the name of the environment variable to disable fsync failure checks with */
  49 #define GMX_IGNORE_FSYNC_FAILURE_ENV "GMX_IGNORE_FSYNC_FAILURE"
  50
  51 /* Write a checkpoint to <fn>.cpt
  52  * Appends the _step<step>.cpt with bNumberAndKeep,
  53  * otherwise moves the previous <fn>.cpt to <fn>_prev.cpt
  54  */
  55 void write_checkpoint(const char *fn, gmx_bool bNumberAndKeep,
  56                       FILE *fplog, t_commrec *cr,
  57                       int eIntegrator, int simulation_part,
  58                       gmx_bool bExpanded, int elamstats,
  59                       gmx_int64_t step, double t,
  60                       t_state *state);
  61
  62 /* Loads a checkpoint from fn for run continuation.
  63  * Generates a fatal error on system size mismatch.
  64  * The master node reads the file
  65  * and communicates all the modified number of steps and the parallel setup,
  66  * but not the state itself.
  67  * When bAppend is set, lock the log file and truncate the existing output
  68  * files so they can be appended.
  69  * With bAppend and bForceAppend: truncate anyhow if the system does not
  70  * support file locking.
  71  */
  72 void load_checkpoint(const char *fn, FILE **fplog,
  73                      t_commrec *cr, gmx_bool bPartDecomp, ivec dd_nc,
  74                      t_inputrec *ir, t_state *state, gmx_bool *bReadRNG,
  75                      gmx_bool *bReadEkin, gmx_bool bAppend, gmx_bool bForceAppend);
  76
  77 /* Read the state from checkpoint file.
  78  * Arrays in state that are NULL are allocated.
  79  * If bReadRNG=TRUE a RNG state compatible with the current
  80  * number of nodes was read.
  81  */
  82 void read_checkpoint_state(const char *fn, int *simulation_part,
  83                            gmx_int64_t *step, double *t, t_state *state);
  84
  85 /* Read everything that can be stored in t_trxframe from a checkpoint file */
  86 void read_checkpoint_trxframe(t_fileio *fp, t_trxframe *fr);
  87
  88 /* Print the complete contents of checkpoint file fn to out */
  89 void list_checkpoint(const char *fn, FILE *out);
  90
  91 /* Read just the simulation 'generation' and with bAppendReq check files.
  92  * This is necessary already at the beginning of mdrun,
  93  * to be able to rename the logfile correctly.
  94  * When file appending is requested, checks which output files are present:
  95  * all present: return TRUE,
  96  * none present: return FALSE,
  97  * part present: fatal error.
  98  * When TRUE is returned, bAddPart will tell whether the simulation part
  99  * needs to be added to the output file name.
 100  */
 101 gmx_bool read_checkpoint_simulation_part(const char *filename, int *simulation_part,
 102                                          gmx_int64_t *step, t_commrec *cr,
 103                                          gmx_bool bAppendReq,
 104                                          int nfile, const t_filenm fnm[],
 105                                          const char *part_suffix, gmx_bool *bAddPart);
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif
 110
 111 #endif