src/gromacs/selection.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014 by the GROMACS development team.
   5  * Copyright (c) 2015,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \defgroup module_selection Parsing and Evaluation of Analysis Selections (selection)
  37  * \ingroup group_analysismodules
  38  * \brief
  39  * Provides functionality for initializing and evaluating selections.
  40  *
  41  * The core of the selection engine is accessed through
  42  * gmx::SelectionCollection, which manages a set of selections.
  43  * Documentation for that class explains the general selection mechanisms.
  44  *
  45  * For each selection that is parsed using a gmx::SelectionCollection, a
  46  * gmx::Selection handle is returned and can be used to access information
  47  * about that selection.  gmx::SelectionPosition is a helper class used to
  48  * access information about individual positions in a selection.  These classes
  49  * refer to internal state within the gmx::SelectionCollection, and their
  50  * contents update automatically when the gmx::SelectionCollection is compiled
  51  * or evaluated.
  52  *
  53  * This module also provides gmx::SelectionOption and gmx::SelectionOptionInfo
  54  * classes for declaring options that evaluate to selections (see \ref
  55  * module_options for general explanation of the options mechanism).  These
  56  * classes provide the main interface to obtain gmx::Selection objects in
  57  * trajectory analysis using gmx::TrajectoryAnalysisModule.
  58  * To use these classes outside the trajectory analysis framework,
  59  * a gmx::SelectionOptionManager or a gmx::SelectionOptionBehavior needs to be
  60  * created to serve as a bridge between the selection option classes and the
  61  * gmx::SelectionCollection object.
  62  * \if libapi
  63  * gmx::SelectionFileOption can be used to implement generic file input for
  64  * selection options (done internally within gmx::SelectionOptionBehavior).
  65  *
  66  * The selection module contains some lower-level functionality that is
  67  * currently internal to it (centerofmass.h, indexutil.h, poscalc.h,
  68  * position.h), but could possibly be useful also outside the module.
  69  * It should be considered whether they should be moved somewhere else.
  70  * \endif
  71  *
  72  * \author Teemu Murtola <teemu.murtola@gmail.com>
  73  */
  74 /*! \file
  75  * \brief
  76  * Public API convenience header for selection handling.
  77  *
  78  * \author Teemu Murtola <teemu.murtola@gmail.com>
  79  * \inpublicapi
  80  * \ingroup module_selection
  81  */
  82 #ifndef GMX_SELECTION_H
  83 #define GMX_SELECTION_H
  84
  85 #include "gromacs/selection/selection.h"
  86 #include "gromacs/selection/selectioncollection.h"
  87 #include "gromacs/selection/selectionoption.h"
  88 #include "gromacs/selection/selectionoptionbehavior.h"
  89 #include "gromacs/selection/selectionoptionmanager.h"
  90
  91 #endif