src/gromacs/selection/position.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2012, 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 handling positions.
  37  *
  38  * \author Teemu Murtola <teemu.murtola@gmail.com>
  39  * \ingroup module_selection
  40  */
  41 #ifndef GMX_SELECTION_POSITION_H
  42 #define GMX_SELECTION_POSITION_H
  43
  44 #include "../legacyheaders/types/simple.h"
  45
  46 #include "indexutil.h"
  47
  48 /*! \brief
  49  * Stores a set of positions together with their origins.
  50  */
  51 typedef struct gmx_ana_pos_t
  52 {
  53     /*! \brief
  54      * Number of positions.
  55      */
  56     int                 nr;
  57     /*! \brief
  58      * Array of positions.
  59      */
  60     rvec               *x;
  61     /*! \brief
  62      * Velocities (can be NULL).
  63      */
  64     rvec               *v;
  65     /*! \brief
  66      * Forces (can be NULL).
  67      */
  68     rvec               *f;
  69     /*! \brief
  70      * Mapping of the current positions to the original group.
  71      *
  72      * \see gmx_ana_indexmap_t
  73      */
  74     gmx_ana_indexmap_t  m;
  75     /*! \brief
  76      * Pointer to the current evaluation group.
  77      */
  78     gmx_ana_index_t    *g;
  79     /*! \brief
  80      * Number of elements allocated for \c x.
  81      */
  82     int                 nalloc_x;
  83 } gmx_ana_pos_t;
  84
  85 /** Initializes an empty position structure. */
  86 void
  87 gmx_ana_pos_clear(gmx_ana_pos_t *pos);
  88 /** Ensures that enough memory has been allocated to store positions. */
  89 void
  90 gmx_ana_pos_reserve(gmx_ana_pos_t *pos, int n, int isize);
  91 /** Request memory allocation for velocities. */
  92 void
  93 gmx_ana_pos_reserve_velocities(gmx_ana_pos_t *pos);
  94 /** Request memory allocation for forces. */
  95 void
  96 gmx_ana_pos_reserve_forces(gmx_ana_pos_t *pos);
  97 /** Initializes a \c gmx_ana_pos_t to represent a constant position. */
  98 void
  99 gmx_ana_pos_init_const(gmx_ana_pos_t *pos, const rvec x);
 100 /** Frees the memory allocated for position storage. */
 101 void
 102 gmx_ana_pos_deinit(gmx_ana_pos_t *pos);
 103 /** Frees the memory allocated for positions. */
 104 void
 105 gmx_ana_pos_free(gmx_ana_pos_t *pos);
 106 /** Copies the evaluated positions to a preallocated data structure. */
 107 void
 108 gmx_ana_pos_copy(gmx_ana_pos_t *dest, gmx_ana_pos_t *src, bool bFirst);
 109
 110 /** Sets the number of positions in a position structure. */
 111 void
 112 gmx_ana_pos_set_nr(gmx_ana_pos_t *pos, int n);
 113 /** Sets the evaluation group of a position data structure. */
 114 void
 115 gmx_ana_pos_set_evalgrp(gmx_ana_pos_t *pos, gmx_ana_index_t *g);
 116 /** Empties a position data structure with full initialization. */
 117 void
 118 gmx_ana_pos_empty_init(gmx_ana_pos_t *pos);
 119 /** Empties a position data structure. */
 120 void
 121 gmx_ana_pos_empty(gmx_ana_pos_t *pos);
 122 /** Appends a position to a preallocated data structure with full
 123  * initialization. */
 124 void
 125 gmx_ana_pos_append_init(gmx_ana_pos_t *dest, gmx_ana_index_t *g,
 126                         gmx_ana_pos_t *src, int i);
 127 /** Appends a position to a preallocated data structure. */
 128 void
 129 gmx_ana_pos_append(gmx_ana_pos_t *dest, gmx_ana_index_t *g,
 130                    gmx_ana_pos_t *src, int i, int refid);
 131 /** Updates position data structure state after appends. */
 132 void
 133 gmx_ana_pos_append_finish(gmx_ana_pos_t *pos);
 134
 135 #endif