2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2014, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
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.
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.
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.
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.
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.
37 * Enumerated types used in the "Computational Electrophysiology" module.
39 * The following enums are mainly used for indexing arrays and when
40 * looping over the available ions, channels, or compartments. This hopefully
41 * adds to the code's readability because it makes clear which object is dealt
42 * with in a block of code.
44 * \author Carsten Kutzner <ckutzne@gwdg.de>
46 * \ingroup module_swap
48 #ifndef GMX_SWAP_ENUMS_H_
49 #define GMX_SWAP_ENUMS_H_
55 /*! \brief The two compartments for CompEL setups. */
57 eCompA, eCompB, eCompNR
60 /*! \brief The positive and negative ions CompEL setups.
62 * Future versions of the protocol might consider more than two types of ions.
65 eIonNEG, eIonPOS, eIonNR
68 /*! \brief The channels that define with their COM the compartment boundaries in CompEL setups.
70 * In principle one could also use modified setups with more than two channels.
73 eChan0, eChan1, eChanNR