View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2021.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  // ******************************************************************************
38  package ffx.crystal;
39  
40  /**
41   * Enumeration of the 7 crystal systems.
42   *
43   * <ul>
44   * <li>TRICLINIC: a&ne;b&ne;c &alpha;&ne;&beta;&ne;&gamma;&ne;90&deg;</li>
45   * <li>MONOCLINIC: a&ne;b&ne;c &alpha;=&gamma;=90&deg;&ne;&beta;</li>
46   * <li>ORTHORHOMBIC: a&ne;b&ne;c &alpha;=&beta;=&gamma;=90&deg;</li>
47   * <li>TETRAGONAL: a=b&ne;c &alpha;=&beta;=&gamma;=90&deg;</li>
48   * <li>TRIGONAL: a=b=c &alpha;=&beta;=&gamma;&ne;90&deg;</li>
49   * <li>HEXAGONAL: a=b&ne;c &alpha;=&beta;=90&deg;, &gamma;=120&deg;</li>
50   * <li>CUBIC: a=b=c &alpha;=&beta;=&gamma;=90&deg;</li>
51   * </ul>
52   *
53   * @author Michael J. Schnieders
54   * @since 1.0
55   */
56  public enum CrystalSystem {
57    TRICLINIC,
58    MONOCLINIC,
59    ORTHORHOMBIC,
60    TETRAGONAL,
61    TRIGONAL,
62    HEXAGONAL,
63    CUBIC
64  }