Step.h

#ifndef CPC_BD_STEP_H
#define CPC_BD_STEP_H
 
/*
* PSCF - Polymer Self-Consistent Field
*
* Copyright 2015 - 2025, 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 Cpc {
 
   using namespace Util;
 
   template <int D> class System;
   template <int D> class Simulator;

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

      Step(Simulator<D>& simulator);

      virtual ~Step();

      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();

      Simulator<D>& simulator();

      Random& random();
 
   private:
      
      Simulator<D>* simulatorPtr_;

      System<D>* systemPtr_;

      Random  *randomPtr_;
 
   };
 
   // Protected inline methods
   
   /*
   * Get parent System object.
   */
   template <int D>
   inline System<D>& Step<D>::system()
   {  return *systemPtr_; }
 
   /*
   * Get parent Simulator object.
   */
   template <int D>
   inline Simulator<D>& Step<D>::simulator()
   {  return *simulatorPtr_; }
 
   /*
   * Get Random number generator.
   */
   template <int D>
   inline Random& Step<D>::random()
   {  return *randomPtr_; }
 
   // Explicit instantiation declarations
   extern template class Step<1>;
   extern template class Step<2>;
   extern template class Step<3>;
 
}
}
#endif