src/gromacs/legacyheaders/displacement.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 /*! \file
  36  * \brief API for on-line calculation of displacements.
  37  *
  38  * The API is documented in more detail on a separate page:
  39  * \ref displacements
  40  *
  41  * The functions within this file can be used and developed independently of
  42  * the other parts of the library.
  43  * Other parts of the library do not reference these functions.
  44  */
  45 #ifndef DISPLACEMENT_H
  46 #define DISPLACEMENT_H
  47
  48 #include "typedefs.h"
  49
  50 #ifdef __cplusplus
  51 extern "C"
  52 {
  53 #endif
  54
  55 /** Data structure for displacement calculation. */
  56 typedef struct gmx_ana_displ_t gmx_ana_displ_t;
  57
  58 struct gmx_ana_pos_t;
  59
  60 /** Allocates memory for displacement calculation. */
  61 int
  62 gmx_ana_displ_create(gmx_ana_displ_t **d, int nmax, real tmax);
  63 /** Initializes displacement calculation for a frame. */
  64 int
  65 gmx_ana_displ_start_frame(gmx_ana_displ_t *d, real t);
  66 /** Returns the number of steps corresponding to a given time interval. */
  67 int
  68 gmx_ana_displ_time_to_steps(gmx_ana_displ_t *d, real time, int *nsteps);
  69 /** Stores the position of a particle for displacement calculation. */
  70 int
  71 gmx_ana_displ_store(gmx_ana_displ_t *d, atom_id id, rvec x, gmx_bool bPres);
  72 /** Convenience function for storing an array of particle positions for displacement calculation. */
  73 int
  74 gmx_ana_displ_store_array(gmx_ana_displ_t *d, int n, atom_id id[], rvec x[]);
  75 /** Stores an array of particle positions for displacement calculation, including unselected particles. */
  76 int
  77 gmx_ana_displ_store_all(gmx_ana_displ_t *d, atom_id id[], rvec x[]);
  78 /** Convenience function for storing a set of positions from \c gmx_ana_pos_t. */
  79 int
  80 gmx_ana_displ_store_pos(gmx_ana_displ_t *d, struct gmx_ana_pos_t *p);
  81 /** Calculates the displacement vector for a particle. */
  82 int
  83 gmx_ana_displ_vector(gmx_ana_displ_t *d, int step, t_pbc *pbc,
  84                      atom_id id, rvec x, rvec xout, gmx_bool *pout);
  85 /** Calculates the displacement vectors for a list of particles. */
  86 int
  87 gmx_ana_displ_vectors(gmx_ana_displ_t *d, int step, t_pbc *pbc,
  88                       int n, atom_id id[], rvec x[],
  89                       rvec xout[], gmx_bool *pout);
  90 /** Calculates the displacement vectors for all particles, including unselected. */
  91 int
  92 gmx_ana_displ_vectors_all(gmx_ana_displ_t *d, int step, t_pbc *pbc,
  93                           rvec x[], rvec xout[], gmx_bool *pout);
  94 /** Frees the memory allocated for displacement calculation. */
  95 void
  96 gmx_ana_displ_free(gmx_ana_displ_t *d);
  97
  98 #ifdef __cplusplus
  99 }
 100 #endif
 101
 102 #endif