MCWF_Trajectory.h

Go to the documentation of this file.

// Copyright András Vukics 2006–2014. Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE.txt)
#ifndef CPPQEDCORE_QUANTUMTRAJECTORY_MCWF_TRAJECTORY_H_INCLUDED
#define CPPQEDCORE_QUANTUMTRAJECTORY_MCWF_TRAJECTORY_H_INCLUDED

#include "MCWF_TrajectoryFwd.h"

#include "StateVectorFwd.h"

#include "MCWF_TrajectoryLogger.h"
#include "QuantumTrajectory.h"
#include "Structure.h"

#include "StochasticTrajectory.h"

#include <boost/tuple/tuple.hpp>


namespace quantumtrajectory {


#define BASE_class trajectory::Stochastic<typename quantumdata::Types<RANK>::StateVectorLow, const quantumdata::StateVector<RANK>&>



template<int RANK>
class MCWF_Trajectory : public QuantumTrajectory<RANK,BASE_class>
{
public:
  typedef structure::Exact        <RANK> Exact      ;
  typedef structure::Hamiltonian  <RANK> Hamiltonian;
  typedef structure::Liouvillean  <RANK> Liouvillean;
  typedef structure::Averaged     <RANK> Averaged   ;

  typedef quantumdata::StateVector<RANK> StateVector;

  typedef typename StateVector::StateVectorLow StateVectorLow;

private:
  typedef quantumtrajectory::QuantumTrajectory<RANK,BASE_class> QuantumTrajectory;
  typedef BASE_class Base;

#undef  BASE_class

  typedef boost::tuple<int,StateVectorLow> IndexSVL_tuple;

public:

  template<typename SYS>
  MCWF_Trajectory(StateVector& psi, 
                  const SYS& sys, 
                  const mcwf::Pars& p, 
                  const StateVectorLow& scaleAbs=StateVectorLow() 
                 );


  void derivs(double, const StateVectorLow&, StateVectorLow&) const;


  const StateVector& getPsi() const {return psi_;} 

  const mcwf::Logger& getLogger() const {return logger_;}
  
  using Base::getTime;

protected:
  using Base::getEvolved; using Base::getDtTry; using QuantumTrajectory::getQSW;

  std::ostream&    display_v(std::ostream&, int    ) const override; 
  std::ostream& displayKey_v(std::ostream&, size_t&) const override; 

  cpputils::iarchive&  readStateMore_v(cpputils::iarchive& iar) override {return QuantumTrajectory::readStateMore_v(iar) & logger_;}
  cpputils::oarchive& writeStateMore_v(cpputils::oarchive& oar) const override {return Base::writeStateMore_v(oar) & logger_;}

  std::ostream& logOnEnd_v(std::ostream& os) const override {return logger_.onEnd(os);} 
  
private:
  typedef std::vector<IndexSVL_tuple> IndexSVL_tuples;
  typedef typename Liouvillean::Rates Rates;

  void step_v(double) override; // performs one single adaptive-stepsize MCWF step of specified maximal length

  std::ostream& displayParameters_v(std::ostream&) const override;

  const StateVector& toBeAveraged_v() const override {return psi_;} 

  const std::string trajectoryID_v() const override {return "MCWF_Trajectory";}

  double                coherentTimeDevelopment(                    double Dt);
  const IndexSVL_tuples calculateSpecialRates  (      Rates* rates, double  t) const;

  bool                  manageTimeStep             (const Rates& rates, evolved::TimeStepBookkeeper*, bool logControl=true);

  void                  performJump                (const Rates&, const IndexSVL_tuples&, double); // LOGICALLY non-const
  // helpers to step---we are deliberately avoiding the normal technique of defining such helpers, because in that case the whole MCWF_Trajectory has to be passed

  StateVector& psi_;

  const double dpLimit_, overshootTolerance_;

  mutable mcwf::Logger logger_;

};


} // quantumtrajectory


#endif // CPPQEDCORE_QUANTUMTRAJECTORY_MCWF_TRAJECTORY_H_INCLUDED