Class Anneal


public class Anneal extends AlgorithmsCommand
The Anneal script.
Usage:
ffxc Anneal [options] <filename>
  • Constructor Details

    • Anneal

      public Anneal()
      Anneal Constructor.
    • Anneal

      public Anneal(FFXBinding binding)
      Anneal Constructor.
      Parameters:
      binding - The Binding to use.
    • Anneal

      public Anneal(String[] args)
      Anneal constructor that sets the command line arguments.
      Parameters:
      args - Command line arguments.
  • Method Details

    • run

      public Anneal run()
      Execute this Command.
      Overrides:
      run in class FFXCommand
      Returns:
      The current FFXCommand.
    • getAnnealing

      public SimulatedAnnealing getAnnealing()
      Get the SimulatedAnnealing object.
      Returns:
      The SimulatedAnnealing instance.
    • getPotentials

      public List<Potential> getPotentials()
      Returns a List of all Potential objects associated with this script.
      Overrides:
      getPotentials in class AlgorithmsCommand
      Returns:
      All Potentials. Sometimes empty, never null.
    • destroyPotentials

      public boolean destroyPotentials()
      Reclaims resources associated with all Potential objects associated with this script.
      Overrides:
      destroyPotentials in class AlgorithmsCommand
      Returns:
      If all Potentials had resources reclaimed.