1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2025.
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.xray.parallel;
39
40 import java.util.logging.Logger;
41
42 import static java.lang.String.format;
43
44 /**
45 * Enum representing the different methods of grid processing.
46 */
47 public enum GridMethod {
48 /**
49 * Decompose into 3D special domains..
50 */
51 SPATIAL,
52 /**
53 * Decompose into 2D slices.
54 */
55 SLICE,
56 /**
57 * Decompose into 1D rows.
58 */
59 ROW;
60
61 // Private logger for the parse method.
62 private static final Logger logger = Logger.getLogger(GridMethod.class.getName());
63
64 /**
65 * Parses the provided method name and returns the corresponding GridMethod enum value.
66 * If the provided method name is not recognized, the default value SLICE is returned.
67 *
68 * @param methodName the name of the grid method to parse (case-insensitive, trimming whitespace).
69 * @return the GridMethod corresponding to the provided method name.
70 */
71 public static GridMethod parse(String methodName) {
72 try {
73 return valueOf(methodName.trim().toUpperCase());
74 } catch (Exception e) {
75 logger.info(format(" %s was not recognized; SLICE grid method selected.", methodName));
76 return SLICE;
77 }
78 }
79 }