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-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.potential.parsers;
39  
40  import ffx.potential.MolecularAssembly;
41  import ffx.potential.bonded.Atom;
42  
43  import java.io.BufferedReader;
44  import java.io.File;
45  import java.io.FileReader;
46  import java.util.List;
47  import java.util.logging.Logger;
48  
49  import static java.lang.Double.parseDouble;
50  import static java.lang.Integer.parseInt;
51  
52  /**
53   * The InducedFilter class parses TINKER Induced Dipole (*.*U) files.
54   *
55   * @author Michael J. Schnieders
56   * @since 1.0
57   */
58  public class InducedFilter {
59  
60    private static final Logger logger = Logger.getLogger(InducedFilter.class.getName());
61    File file;
62    private final MolecularAssembly molecularAssembly;
63  
64    /**
65     * Constructor for InducedFilter.
66     *
67     * @param s a {@link ffx.potential.MolecularAssembly} object.
68     * @param f a {@link java.io.File} object.
69     */
70    public InducedFilter(MolecularAssembly s, File f) {
71      molecularAssembly = s;
72      file = f;
73    }
74  
75    /**
76     * read
77     *
78     * @return a boolean.
79     */
80    public boolean read() {
81      if (!file.exists() || !file.canRead()) {
82        return false;
83      }
84      try (BufferedReader br = new BufferedReader(new FileReader(file))) {
85        String data = br.readLine();
86        String[] tokens = data.trim().split(" +");
87        if (tokens.length == 0) {
88          return false;
89        }
90        int numAtoms = parseInt(tokens[0]);
91        if (numAtoms != molecularAssembly.getAtomList().size()) {
92          return false;
93        }
94        // Read the Induced Dipoles
95        double[][] x = new double[numAtoms][3];
96        for (int i = 0; i < numAtoms; i++) {
97          data = br.readLine().trim();
98          tokens = data.split(" +");
99          if (tokens.length != 5) {
100           return false;
101         }
102         x[i][0] = parseDouble(tokens[2]);
103         x[i][1] = parseDouble(tokens[3]);
104         x[i][2] = parseDouble(tokens[4]);
105       }
106       List<Atom> atoms = molecularAssembly.getAtomList();
107       double max = 0.0d;
108       for (Atom a : atoms) {
109         int j = a.getIndex() - 1;
110         // a.setInducedDipole(-x[j][0], -x[j][1], -x[j][2]);
111       }
112       logger.warning("Max Induced: " + max);
113     } catch (Exception e) {
114       return false;
115     }
116     return true;
117   }
118 }