rpc/fts/brownian/BdStep.h

#ifndef RPC_BD_STEP_H
#define RPC_BD_STEP_H
 
/*
* PSCF - Polymer Self-Consistent Field Theory
*
* Copyright 2016 - 2022, 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 Pscf {
namespace Rpc {
 
   using namespace Util;
 
   template <int D> class System;
   template <int D> class BdSimulator;
 
   template <int D>
   class BdStep : public ParamComposite
   {
 
   public:
 
      BdStep(BdSimulator<D>& simulator);
 
      virtual ~BdStep();
 
      virtual void readParameters(std::istream &in);
 
      virtual void setup();
 
      virtual bool step() = 0;
      
      virtual bool needsCc()
      {  return false; }
      
      virtual bool needsDc()
      { return true; }
      
      virtual void outputTimers(std::ostream& out);
      
      virtual void clearTimers();
      
      virtual void output();
 
   protected:
      
      System<D>& system();
 
      BdSimulator<D>& simulator();
 
      Random& random();
 
   private:
      
      BdSimulator<D>* simulatorPtr_;
 
      System<D>* systemPtr_;
 
      Random  *randomPtr_;
 
   };
 
   // Protected inline methods
   
   /*
   * Get parent System object.
   */
   template <int D>
   inline System<D>& BdStep<D>::system()
   {  return *systemPtr_; }
 
   /*
   * Get parent BdSimulator object.
   */
   template <int D>
   inline BdSimulator<D>& BdStep<D>::simulator()
   {  return *simulatorPtr_; }
 
   /*
   * Get Random number generator.
   */
   template <int D>
   inline Random& BdStep<D>::random()
   {  return *randomPtr_; }
 
   #ifndef RPC_BD_STEP_TPP
   // Suppress implicit instantiation
   extern template class BdStep<1>;
   extern template class BdStep<2>;
   extern template class BdStep<3>;
   #endif
 
}
}
#endif