rp/solvers/Propagator.h

#ifndef RP_PROPAGATOR_H
#define RP_PROPAGATOR_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 <pscf/solvers/PropagatorTmpl.h> // base class template
#include <util/containers/DArray.h>      // member
 
 
// Forward declaration
namespace Pscf {
   template <int D> class Mesh;
}
 
namespace Pscf {
namespace Rp {
 
   using namespace Util;

   template <int D, class T>
   class Propagator : public PropagatorTmpl<typename T::Propagator>
   {
 
   public:

      void setBlock(typename T::Block& block);

      virtual void allocate(int ns, const Mesh<D>& mesh);

      virtual void reallocate(int ns);

      void solve();

      void solve(typename T::RField const & head);

      void computeQ(double & Q) const;

      const typename T::RField& q(int i) const;

      const typename T::RField& head() const;

      const typename T::RField& tail() const;

      typename T::Block const & block() const;

      Mesh<D> const & mesh() const;

      int ns() const;

      bool isAllocated() const;

      using PropagatorTmplT = PropagatorTmpl<typename T::Propagator>;
 
      // Inherited non-dependent members (selected, for convenience)
      using PropagatorTmplT::source;
      using PropagatorTmplT::partner;
 
   protected:

      DArray<typename T::RField> qFields_;

      int ns_;

      bool isAllocated_;

      Propagator();

      ~Propagator();

      void computeHead();

      void solveMde();

      typename T::Block& block();
 
   private:

      typename T::Block* blockPtr_;

      Mesh<D> const * meshPtr_;
 
   };
 
   // Inline member functions
 
   /*
   * Return q-field at beginning of block.
   */
   template <int D, class T> inline
   typename T::RField const& Propagator<D,T>::head() const
   {
      UTIL_CHECK(PropagatorTmplT::isSolved());
      return qFields_[0];
   }
 
   /*
   * Return q-field at end of block.
   */
   template <int D, class T> inline
   typename T::RField const& Propagator<D,T>::tail() const
   {
      UTIL_CHECK(PropagatorTmplT::isSolved());
      UTIL_CHECK(PolymerModel::isThread() || !PropagatorTmplT::isTailEnd());
      return qFields_[ns_-1];
   }
 
   /*
   * Return q-field at specified step.
   */
   template <int D, class T> inline
   typename T::RField const& Propagator<D,T>::q(int i) const
   {
      UTIL_CHECK(PropagatorTmplT::isSolved());
      return qFields_[i];
   }
 
   /*
   * Get the associated Block object by const reference.
   */
   template <int D, class T> inline
   typename T::Block const & Propagator<D,T>::block() const
   {
      UTIL_ASSERT(blockPtr_);
      return *blockPtr_;
   }
 
   /*
   * Get the associated Block object by non-const reference.
   */
   template <int D, class T> inline
   typename T::Block& Propagator<D,T>::block()
   {
      UTIL_ASSERT(blockPtr_);
      return *blockPtr_;
   }
 
   /*
   * Get the associated Mesh object by const reference.
   */
   template <int D, class T> inline
   Mesh<D> const & Propagator<D,T>::mesh() const
   {
      UTIL_ASSERT(meshPtr_);
      return *meshPtr_;
   }
 
   /*
   * Get the number of counter grid points.
   */
   template <int D, class T> inline
   int Propagator<D,T>::ns() const
   {  return ns_; }
 
   /*
   * Has memory been allocated for this propagator?
   */
   template <int D, class T> inline
   bool Propagator<D,T>::isAllocated() const
   {  return isAllocated_; }
 
   /*
   * Associate this propagator with a unique block.
   */
   template <int D, class T> inline
   void Propagator<D,T>::setBlock(typename T::Block& block)
   {  blockPtr_ = &block; }
 
} // namespace Rp
} // namespace Pscf
#endif