1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2024.
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.potential.nonbonded.pme;
39
40 import ffx.potential.Platform;
41
42 import java.util.ArrayList;
43 import java.util.Collections;
44 import java.util.List;
45
46 /**
47 * Describes available SCF algorithms, and whether they are supported by the FFX and/or CUDA
48 * implementations.
49 */
50 public enum SCFAlgorithm {
51 SOR(true, true),
52 CG(true, true),
53 EPT(true, true);
54
55 private final List<Platform> supportedPlatforms;
56
57 SCFAlgorithm(boolean ffx, boolean openMM) {
58 List<Platform> platforms = new ArrayList<>();
59 if (ffx) {
60 platforms.add(Platform.FFX);
61 }
62 if (openMM) {
63 platforms.add(Platform.OMM);
64 platforms.add(Platform.OMM_CUDA);
65 platforms.add(Platform.OMM_REF);
66 }
67 supportedPlatforms = Collections.unmodifiableList(platforms);
68 }
69
70 /**
71 * Checks if this platform is supported
72 *
73 * @param platform To check
74 * @return Supported
75 */
76 public boolean isSupported(Platform platform) {
77 return supportedPlatforms.contains(platform);
78 }
79 }