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.algorithms.commands.test;
39  
40  import ffx.algorithms.cli.AlgorithmsCommand;
41  import ffx.algorithms.cli.DynamicsOptions;
42  import ffx.algorithms.dynamics.MolecularDynamics;
43  import ffx.algorithms.dynamics.WeightedEnsembleManager;
44  import ffx.algorithms.dynamics.WeightedEnsembleManager.OneDimMetric;
45  import ffx.numerics.Potential;
46  import ffx.potential.MolecularAssembly;
47  import ffx.potential.cli.AtomSelectionOptions;
48  import ffx.potential.cli.WriteoutOptions;
49  import ffx.utilities.FFXBinding;
50  import picocli.CommandLine.Command;
51  import picocli.CommandLine.Mixin;
52  import picocli.CommandLine.Option;
53  import picocli.CommandLine.Parameters;
54  
55  import java.io.File;
56  
57  /**
58   * WeightedEnsemble
59   * <br>
60   * Usage: Accelerated Sampling with Weighted Ensemble
61   * <br>
62   * ffxc test.WeightedEnsemble [options] &lt;filename&gt; [file2...];
63   */
64  @Command(description = " Runs parallel simulations with intermittent resampling.", name = "test.WeightedEnsemble")
65  public class WeightedEnsemble extends AlgorithmsCommand {
66  
67    @Mixin
68    private AtomSelectionOptions atomSelectionOptions;
69  
70    @Mixin
71    private DynamicsOptions dynamicsOptions;
72  
73    @Mixin
74    private WriteoutOptions writeOutOptions;
75  
76    @Option(names = {"--stepsPer"}, paramLabel = "10000", defaultValue = "10000",
77        description = "Number of steps to take between resampling cycles.")
78    private int stepsPer;
79  
80    @Option(names = {"--initDynamics"}, paramLabel = "10000", defaultValue = "10000",
81        description = "Number of initialization steps to take before windows start. This is good for getting diverse starting structures.")
82    private int initDynamics;
83  
84    @Option(names = {"--numPerBin"}, paramLabel = "2", defaultValue = "2",
85        description = "Number of walkers per bin.")
86    private int numPerBin;
87  
88    @Option(names = {"--oneDimensionalMetric"}, paramLabel = "RMSD", defaultValue = "RMSD",
89        description = "Bin across this metric. Options: RMSD, POTENTIAL, RESIDUE_DISTANCE, ATOM_DISTANCE, COM_DISTANCE, RADIUS_OF_GYRATION")
90    private String oneDimensionalMetric;
91  
92    /**
93     * One or more filenames.
94     */
95    @Parameters(arity = "1..*", paramLabel = "files",
96        description = "XYZ or PDB input files.")
97    private String filename;
98  
99    /**
100    * Constructor.
101    */
102   public WeightedEnsemble() {
103     super();
104   }
105 
106   /**
107    * Constructor.
108    * @param binding The Binding to use.
109    */
110   public WeightedEnsemble(FFXBinding binding) {
111     super(binding);
112   }
113 
114   /**
115    * WeightedEnsemble constructor that sets the command line arguments.
116    * @param args Command line arguments.
117    */
118   public WeightedEnsemble(String[] args) {
119     super(args);
120   }
121 
122   /**
123    * {@inheritDoc}
124    */
125   @Override
126   public WeightedEnsemble run() {
127     if (!init()) {
128       return this;
129     }
130     dynamicsOptions.init();
131 
132     // Set up FFX integrator
133     MolecularAssembly assembly = getActiveAssembly(filename);
134     File file = assembly.getFile();
135     if (file == null) {
136       logger.severe(" No file found for assembly: " + assembly);
137     } else {
138       logger.info(" Running Weighted Ensemble on " + file);
139     }
140     Potential potential = assembly.getPotentialEnergy();
141     double[] x = new double[potential.getNumberOfVariables()];
142     potential.getCoordinates(x);
143     potential.energy(x, true);
144     MolecularDynamics md = dynamicsOptions.getDynamics(writeOutOptions, potential, assembly, algorithmListener);
145 
146     // Set up & run Weighted Ensemble
147     OneDimMetric metric = null;
148     try {
149       metric = OneDimMetric.valueOf(oneDimensionalMetric);
150     } catch (IllegalArgumentException e) {
151       logger.severe(" Invalid oneDimensionalMetric: " + oneDimensionalMetric);
152       return this;
153     }
154     WeightedEnsembleManager weightedEnsemble = new WeightedEnsembleManager(metric, numPerBin, md, file, true);
155     weightedEnsemble.run(dynamicsOptions.getSteps(), stepsPer, dynamicsOptions.getTemperature(), dynamicsOptions.getDt());
156 
157     return this;
158   }
159 }