McMove.h

#ifndef MCMD_MC_MOVE_H
#define MCMD_MC_MOVE_H

/*
* Simpatico - Simulation Package for Polymeric and Molecular Liquids
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/

#include <util/param/ParamComposite.h>
#include <util/random/Random.h>
#include <util/global.h>

namespace McMd
{

   using namespace Util;

   class Simulation;

   class McMove : public ParamComposite
   {

   public:

      McMove(Simulation& simulation);

      virtual ~McMove();

      virtual void readParameters(std::istream &in);

      virtual void loadParameters(Serializable::IArchive &ar);

      virtual void save(Serializable::OArchive &ar);

      void setProbability(double probability);

      virtual void setup();

      virtual bool move();

      // Accessor Functions

      double probability() const;

      long nAttempt() const;

      long nAccept() const;

      virtual void output();

   protected:

      void incrementNAttempt();

      void incrementNAccept();

      Simulation& simulation();

      Random& random();

      void readProbability(std::istream& in);

   private:

      Simulation  *simulationPtr_;

      Random  *randomPtr_;

      double  probability_;

      long  nAttempt_;

      long  nAccept_;

   };

   // Public inline methods

   /*
   * Return number of moves that have been attempted.
   */
   inline long McMove::nAttempt() const
   {  return nAttempt_; }

   /*
   * Return number of moves that have been accepted.
   */
   inline long McMove::nAccept() const
   {  return nAccept_; }

   // Protected inline methods

   /*
   * Increment the number of attempted moves.
   */
   inline void McMove::incrementNAttempt()
   {  ++nAttempt_; }

   /*
   * Increment the number of accepted moves.
   */
   inline void McMove::incrementNAccept()
   {  ++nAccept_; }

   /*
   * Get parent Simulation object.
   */
   inline Simulation& McMove::simulation()
   {  return *simulationPtr_; }

   /*
   * Get Random number generator.
   */
   inline Random& McMove::random()
   {  return *randomPtr_; }

   /*
   * Get the probability.
   */
   inline double McMove::probability() const
   {  return probability_; }

   /*
   * Set the probability.
   */
   inline void McMove::setProbability(double probability)
   {  probability_ = probability; }

}
#endif