rpc/fts/brownian/BdSimulator.h

#ifndef RPC_BD_SIMULATOR_H
#define RPC_BD_SIMULATOR_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 <rpc/fts/simulator/Simulator.h>                  // base class
#include <rpc/fts/analyzer/AnalyzerManager.h>   // member
#include <util/param/Factory.h>                      // member template
 
namespace Pscf {
namespace Rpc {
 
   using namespace Util;
 
   template <int D> class BdStep;
   template <int D> class TrajectoryReader;
 
   template <int D>
   class BdSimulator : public Simulator<D>
   {
 
   public:
 
      BdSimulator(System<D>& system);
 
      ~BdSimulator();
 
      virtual void readParameters(std::istream &in);
 
 
      void simulate(int nStep);
 
      virtual void analyze(int min, int max,
                           std::string classname,
                           std::string filename);
 
 
      bool hasBdStep() const;
 
      BdStep<D>& bdStep();
 
      AnalyzerManager<D>& analyzerManager();
 
      Factory<TrajectoryReader<D>>& trajectoryReaderFactory();
 
 
      // Inherited public functions
 
      using Simulator<D>::system;
      using Simulator<D>::random;
      using Simulator<D>::analyzeChi;
      using Simulator<D>::chiEval;
      using Simulator<D>::chiEvecs;
      using Simulator<D>::computeWc;
      using Simulator<D>::computeCc;
      using Simulator<D>::computeDc;
      using Simulator<D>::wc;
      using Simulator<D>::cc;
      using Simulator<D>::dc;
      using Simulator<D>::hasWc;
      using Simulator<D>::hasCc;
      using Simulator<D>::hasDc;
      using Simulator<D>::clearData;
      using Simulator<D>::computeHamiltonian;
      using Simulator<D>::hamiltonian;
      using Simulator<D>::idealHamiltonian;
      using Simulator<D>::fieldHamiltonian;
      using Simulator<D>::perturbationHamiltonian;
      using Simulator<D>::hasHamiltonian;
      using Simulator<D>::hasCompressor;
      using Simulator<D>::compressor;
      using Simulator<D>::hasPerturbation;
      using Simulator<D>::perturbation;
      using Simulator<D>::hasRamp;
      using Simulator<D>::ramp;
      using Simulator<D>::saveState;
      using Simulator<D>::restoreState;
      using Simulator<D>::clearState;
      using Simulator<D>::outputMdeCounter;
 
   protected:
 
      // Inherited protected functions
 
      using ParamComponent::indent;
      using ParamComposite::setClassName;
      using ParamComposite::readParamComposite;
      using ParamComposite::readParamCompositeOptional;
      using ParamComposite::readOptional;
      using Simulator<D>::readRandomSeed;
      using Simulator<D>::readCompressor;
      using Simulator<D>::readPerturbation;
      using Simulator<D>::readRamp;
      using Simulator<D>::compressorFactory;
      using Simulator<D>::perturbationFactory;
      using Simulator<D>::rampFactory;
      using Simulator<D>::setRamp;
      using Simulator<D>::setPerturbation;
 
      // Inherited protected data members
 
      using Simulator<D>::wc_;
      using Simulator<D>::hasWc_;
      using Simulator<D>::hamiltonian_;
      using Simulator<D>::idealHamiltonian_;
      using Simulator<D>::fieldHamiltonian_;
      using Simulator<D>::hasHamiltonian_;
      using Simulator<D>::iStep_;
      using Simulator<D>::iTotalStep_;
      using Simulator<D>::state_;
      using Simulator<D>::seed_;
 
   private:
 
      AnalyzerManager<D> analyzerManager_;
 
      BdStep<D>* bdStepPtr_;
 
      Factory< BdStep<D> >* bdStepFactoryPtr_;
 
      Factory< TrajectoryReader<D> >* trajectoryReaderFactoryPtr_;
 
      // Private member functions
 
      void setup(int nStep);
 
   };
 
   // Get the Brownian dynamics stepper.
   template <int D>
   inline bool BdSimulator<D>::hasBdStep() const
   {  return (bool)bdStepPtr_; }
 
   // Get the Brownian dynamics stepper.
   template <int D>
   inline BdStep<D>& BdSimulator<D>::bdStep()
   {
      UTIL_CHECK(hasBdStep());  
      return *bdStepPtr_; 
   }
 
   // Get the analyzer manager.
   template <int D>
   inline AnalyzerManager<D>& BdSimulator<D>::analyzerManager()
   {  return analyzerManager_; }
 
   // Get the TrajectoryReaderfactory
   template <int D>
   inline
   Factory<TrajectoryReader<D> >& BdSimulator<D>::trajectoryReaderFactory()
   {
      UTIL_ASSERT(trajectoryReaderFactoryPtr_);
      return *trajectoryReaderFactoryPtr_;
   }
 
   #ifndef RPC_BD_SIMULATOR_TPP
   // Suppress implicit instantiation
   extern template class BdSimulator<1>;
   extern template class BdSimulator<2>;
   extern template class BdSimulator<3>;
   #endif
 
}
}
#endif