LangevinThermostatOptimizerState.h

Go to the documentation of this file.

/**
 *  \file IMP/atom/LangevinThermostatOptimizerState.h
 *  \brief Maintains temperature during molecular dynamics using
 *         a Langevin thermostat.
 *
 *  Copyright 2007-2013 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPATOM_LANGEVIN_THERMOSTAT_OPTIMIZER_STATE_H
#define IMPATOM_LANGEVIN_THERMOSTAT_OPTIMIZER_STATE_H

#include <IMP/atom/atom_config.h>
#include <IMP/kernel/Particle.h>
#include <IMP/base_types.h>
#include <IMP/OptimizerState.h>
#include <IMP/optimizer_state_macros.h>

IMPATOM_BEGIN_NAMESPACE

//! Maintains temperature during molecular dynamics.
/** The thermostat scales velocities using the algorithm described in
    G. Bussi and M. Parrinello "Accurate sampling using Langevin dynamics",
    Phys. Rev. E 75, 056707 (2007)
 */
class IMPATOMEXPORT LangevinThermostatOptimizerState : public OptimizerState {
 public:
  /** \deprecated_at{2.1} Use constructor that takes indexes. */
  IMPATOM_DEPRECATED_FUNCTION_DECL(2.1)
  LangevinThermostatOptimizerState(const kernel::ParticlesTemp &pis,
                                   double temperature, double gamma);

  LangevinThermostatOptimizerState(Model *m, ParticleIndexesAdaptor pis,
                                   double temperature, double gamma);

  //! Set the particles to use.
  void set_particles(const kernel::Particles &pis) { pis_ = pis; }

  double get_temperature() { return temperature_; }

  double get_gamma() { return gamma_; }

  void set_temperature(double temperature) { temperature_ = temperature; }

  void set_gamma(double gamma) { gamma_ = gamma; }

  //! Rescale the velocities now
  void rescale_velocities() const;

  IMP_OBJECT_METHODS(LangevinThermostatOptimizerState);

 protected:
  virtual void do_update(unsigned int) IMP_OVERRIDE;

 private:
  kernel::Particles pis_;
  double temperature_;
  double gamma_;

  //! Keys of the xyz velocities
  FloatKey vs_[3];
};

IMP_OBJECTS(LangevinThermostatOptimizerState,
            LangevinThermostatOptimizerStates);

IMPATOM_END_NAMESPACE

#endif /* IMPATOM_LANGEVIN_THERMOSTAT_OPTIMIZER_STATE_H */