fts/brownian/BdStep.h

#ifndef RP_BD_STEP_H
#define RP_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>    // base class
#include <util/global.h>
 
// Forward declaration
namespace Util {
   class Random;
}
 
namespace Pscf {
namespace Rp {
 
   using namespace Util;

   template <int D, class T>
   class BdStep : public ParamComposite
   {
   public:
 
      // Protected constructor and destructor (see below).
 
      // Not copyable or assignable.
      BdStep(BdStep<D,T> const &) = delete;
      BdStep<D,T>& operator = (BdStep<D,T> const &) = delete;

      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:
      
      BdStep(typename T::BdSimulator& simulator);
 
      ~BdStep() = default;

      typename T::System& system();

      typename T::BdSimulator& simulator();

      Random& random();

      typename T::VecRandom& vecRandom();
 
   private:
      
      typename T::BdSimulator* simulatorPtr_;

      typename T::System* systemPtr_;

      Random  *randomPtr_;

      typename T::VecRandom  *vecRandomPtr_;
 
   };
 
   // Protected inline methods
   
   /*
   * Get parent System object.
   */
   template <int D, class T> inline 
   typename T::System& BdStep<D,T>::system()
   {  return *systemPtr_; }
 
   /*
   * Get parent BdSimulator object.
   */
   template <int D, class T> inline 
   typename T::BdSimulator& BdStep<D,T>::simulator()
   {  return *simulatorPtr_; }
 
   /*
   * Get the scalar random number generator.
   */
   template <int D, class T> inline 
   Random& BdStep<D,T>::random()
   {  return *randomPtr_; }
 
   /*
   * Get the vector random number generator.
   */
   template <int D, class T> inline 
   typename T::VecRandom& BdStep<D,T>::vecRandom()
   {  return *vecRandomPtr_; }
 
}
}
#endif