rpc/fts/perturbation/Perturbation.h

#ifndef RPC_PERTURBATION_H
#define RPC_PERTURBATION_H
 
#include <util/param/ParamComposite.h>      // base class
 
namespace Util {
   template <typename T> class DArray;
}
 
namespace Pscf {
namespace Prdc{
namespace Cpu{
   template <int D> class RField;
}
}
}
 
namespace Pscf {
namespace Rpc {
 
   using namespace Util;
   using namespace Prdc;
   using namespace Prdc::Cpu;
 
   template <int D> class System;
   template <int D> class Simulator;

   template <int D>
   class Perturbation : public ParamComposite
   {
 
   public:

      Perturbation(Simulator<D>& simulator);

      virtual ~Perturbation();

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

      virtual void setup();

      virtual double hamiltonian(double unperturbedHamiltonian);

      virtual void incrementDc(DArray< RField<D> >& dc);

      virtual void saveState();

      virtual void restoreState();
       
      virtual double df();

      Simulator<D> const & simulator() const;
            
      System<D> const & system() const;
 
      double lambda() const
      {  return lambda_; }

      void setLambda(double lambda);
 
   protected:

      Simulator<D>& simulator();
      
      System<D>& system();
      
      double lambda_;
 
   private:

      Simulator<D>* simulatorPtr_;
      
      System<D>* systemPtr_;
 
   };
 
   // Inline methods
 
   // Return parent simulator by const reference.
   template <int D>
   inline Simulator<D> const & Perturbation<D>::simulator() const
   {
      assert(simulatorPtr_);  
      return *simulatorPtr_; 
   }
 
   // Return parent simulator by non-const reference.
   template <int D>
   inline Simulator<D> & Perturbation<D>::simulator() 
   {  
      assert(simulatorPtr_);  
      return *simulatorPtr_; 
   }
   
   // Return parent simulator by const reference.
   template <int D>
   inline System<D> const & Perturbation<D>::system() const
   {  
      assert(systemPtr_);  
      return *systemPtr_; 
   }
   
   // Return parent simulator by non-const reference.
   template <int D>
   inline System<D> & Perturbation<D>::system() 
   {  
      assert(systemPtr_);  
      return *systemPtr_; 
   }
 
   #ifndef RPC_PERTURBATION_TPP
   // Suppress implicit instantiation
   extern template class Perturbation<1>;
   extern template class Perturbation<2>;
   extern template class Perturbation<3>;
   #endif
 
}
}
#endif