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.commands;
39  
40  import ffx.numerics.Potential;
41  import ffx.potential.MolecularAssembly;
42  import ffx.potential.bonded.Atom;
43  import ffx.potential.cli.PotentialCommand;
44  import ffx.utilities.FFXBinding;
45  import picocli.CommandLine.Command;
46  import picocli.CommandLine.Parameters;
47  
48  import java.io.File;
49  import java.util.ArrayList;
50  import java.util.Arrays;
51  import java.util.List;
52  import java.util.stream.Collectors;
53  
54  import static org.apache.commons.io.FilenameUtils.getExtension;
55  import static org.apache.commons.io.FilenameUtils.getName;
56  import static org.apache.commons.io.FilenameUtils.removeExtension;
57  
58  /**
59   * Move the center of mass of each molecule into the unit cell.
60   *
61   * Usage:
62   *   ffxc MoveIntoUnitCell <filename>
63   */
64  @Command(name = "MoveIntoUnitCell", description = " Move all molecules into the unit cell.")
65  public class MoveIntoUnitCell extends PotentialCommand {
66  
67    /** The final argument is a PDB or XYZ coordinate file. */
68    @Parameters(arity = "1", paramLabel = "file",
69        description = "The atomic coordinate file in PDB or XYZ format.")
70    private String filename = null;
71  
72    /** Save a reference to the MolecularAssembly instances to destroy their potentials. */
73    protected MolecularAssembly[] molecularAssemblies = null;
74  
75    /** Original Cartesian coordinates before moving into the unit cell. */
76    public double[][] origCoordinates = null;
77    /** Cartesian coordinates after moving into the unit cell. */
78    public double[][] unitCellCoordinates = null;
79  
80    public MoveIntoUnitCell() { super(); }
81    public MoveIntoUnitCell(FFXBinding binding) { super(binding); }
82    public MoveIntoUnitCell(String[] args) { super(args); }
83  
84    @Override
85    public MoveIntoUnitCell run() {
86      // Init the context and bind variables.
87      if (!init()) {
88        return this;
89      }
90  
91      // Load one or more MolecularAssembly instances.
92      molecularAssemblies = getActiveAssemblies(filename);
93      if (activeAssembly == null) {
94        logger.info(helpString());
95        return this;
96      }
97  
98      // Set the filename.
99      filename = activeAssembly.getFile().getAbsolutePath();
100 
101     logger.info("\n Moving molecular centers of mass into the unit cell for " + filename + "\n");
102 
103     // Loop over each system.
104     for (MolecularAssembly molecularAssembly : molecularAssemblies) {
105       Atom[] atoms = molecularAssembly.getAtomArray();
106       int nAtoms = atoms.length;
107       origCoordinates = new double[nAtoms][3];
108       unitCellCoordinates = new double[nAtoms][3];
109 
110       for (int index = 0; index < nAtoms; index++) {
111         Atom atom = atoms[index];
112         origCoordinates[index][0] = atom.getX();
113         origCoordinates[index][1] = atom.getY();
114         origCoordinates[index][2] = atom.getZ();
115       }
116 
117       molecularAssembly.moveAllIntoUnitCell();
118 
119       for (int index = 0; index < nAtoms; index++) {
120         Atom atom = atoms[index];
121         unitCellCoordinates[index][0] = atom.getX();
122         unitCellCoordinates[index][1] = atom.getY();
123         unitCellCoordinates[index][2] = atom.getZ();
124       }
125     }
126 
127     // Get the base name of the file and its extension.
128     String name = getName(filename);
129     String ext = getExtension(name);
130     name = removeExtension(name);
131 
132     // Use the current base directory, or update if necessary based on the given filename.
133     String dirString = getBaseDirString(filename);
134 
135     if (ext.toUpperCase().contains("XYZ")) {
136       potentialFunctions.saveAsXYZ(molecularAssemblies[0], new File(dirString + name + ".xyz"));
137     } else {
138       potentialFunctions.saveAsPDB(molecularAssemblies, new File(dirString + name + ".pdb"));
139     }
140 
141     return this;
142   }
143 
144   @Override
145   public List<Potential> getPotentials() {
146     if (molecularAssemblies == null) {
147       return new ArrayList<>();
148     } else {
149       return Arrays.stream(molecularAssemblies)
150           .filter(a -> a != null)
151           .map(MolecularAssembly::getPotentialEnergy)
152           .filter(e -> e != null)
153           .collect(Collectors.toList());
154     }
155   }
156 }