Package ffx.algorithms.mc

Interface MonteCarloListener

All Known Implementing Classes:
MCLoop, RosenbluthCBMC, RosenbluthOBMC
public interface MonteCarloListener
The MonteCarloListener will be notified at regular intervals during an MC algorithm. This interface is useful for updating the user interface or terminating the algorithm.
Since:
1.0
Author:
Michael J. Schnieders

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    boolean
    mcUpdate(double temperature)
    After a successful step or interval of an algorithm, this method of the listener will be called.

  • Method Details Link icon

    • mcUpdate Link icon

      boolean mcUpdate(double temperature)
      After a successful step or interval of an algorithm, this method of the listener will be called.

      Temperature argument is necessary since Potentials package cannot import Thermostat/MD.

      Parameters:
      temperature - The Metropolis Monte Carlo temperature.
      Returns:
      A return of true indicates the algorithm continues.