PropagatorTmpl.h

#ifndef PSCF_PROPAGATOR_TMPL_H
#define PSCF_PROPAGATOR_TMPL_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/chem/PolymerModel.h>
#include <util/containers/GArray.h>
 
namespace Pscf
{ 
 
   using namespace Util;

   template <class QT>
   class PropagatorTmpl
   {
 
   public:
 
      // Protected constructor and destructor (see below).

  
      void setDirectionId(int directionId);

      void setPartner(const QT& partner);

      void addSource(const QT& source);

      void setIsSolved(bool isSolved);

      void setEndFlags(bool isHeadEnd, bool isTailEnd);
 

      const QT& source(int id) const;

      const QT& partner() const;

      int directionId() const;

      int nSource() const;

      bool hasPartner() const;

      bool isHeadEnd() const;

      bool isTailEnd() const;

      bool isSolved() const;
 
      bool isReady() const;
 
 
   protected:
 
      PropagatorTmpl();
 
      ~PropagatorTmpl() = default;
 
   private:
  
      int directionId_;

      QT const * partnerPtr_;

      GArray<QT const *> sourcePtrs_;

      bool isHeadEnd_;

      bool isTailEnd_;

      bool isSolved_;
  
   };
 
   // Inline member functions
 
   /*
   * Get the direction index.
   */
   template <class QT>
   inline int PropagatorTmpl<QT>::directionId() const
   {  return directionId_; }
 
   /*
   * Get the number of source propagators.
   */
   template <class QT>
   inline int PropagatorTmpl<QT>::nSource() const
   {  return sourcePtrs_.size(); }
 
   /*
   * Get a source propagator.
   */
   template <class QT>
   inline const QT& 
   PropagatorTmpl<QT>::source(int id) const
   {  return *(sourcePtrs_[id]); }

   template <class QT>
   inline bool PropagatorTmpl<QT>::hasPartner() const
   {  return partnerPtr_; }
 
   /*
   * Does this propagator own the head vertex bead?
   */
   template <class QT>
   inline bool PropagatorTmpl<QT>::isHeadEnd() const
   {  return isHeadEnd_; }
 
   /*
   * Does this propagator own the tail vertex bead?
   */
   template <class QT>
   inline bool PropagatorTmpl<QT>::isTailEnd() const
   {  return isTailEnd_; }
 
   /*
   * Is the computation of this propagator completed?
   */
   template <class QT>
   inline bool PropagatorTmpl<QT>::isSolved() const
   {  return isSolved_; }
 
   // Noninline member functions
 
   /*
   * Constructor.
   */
   template <class QT>
   PropagatorTmpl<QT>::PropagatorTmpl()
    : directionId_(-1),
      partnerPtr_(0),
      sourcePtrs_(),
      isSolved_(false)
   {}
 
   /*
   * Set the directionId.
   */
   template <class QT>
   void PropagatorTmpl<QT>::setDirectionId(int directionId)
   {  directionId_ = directionId; }
 
   /*
   * Set the partner propagator.
   */
   template <class QT>
   void PropagatorTmpl<QT>::setPartner(const QT& partner)
   {  partnerPtr_ = &partner; }
 
   /*
   * Add a source propagator to the list.
   */
   template <class QT>
   void PropagatorTmpl<QT>::addSource(const QT& source)
   {  sourcePtrs_.append(&source); }
 
   /*
   * Set flags indicate whether vertices are are chain ends.
   */
   template <class QT>
   void PropagatorTmpl<QT>::setEndFlags(bool isHeadEnd, bool isTailEnd)
   {
      isHeadEnd_ = isHeadEnd;  
      isTailEnd_ = isTailEnd;  
   }
 
   /*
   * Check if all source propagators are marked completed.
   */
   template <class QT>
   bool PropagatorTmpl<QT>::isReady() const
   {
      for (int i=0; i < sourcePtrs_.size(); ++i) {
         if (!sourcePtrs_[i]->isSolved()) {
            return false;
         }
      }
      return true;
   }
 
   /*
   * Mark this propagator as solved (true) or not (false).
   */
   template <class QT>
   void PropagatorTmpl<QT>::setIsSolved(bool isSolved)
   {  isSolved_ = isSolved; }
 
   /*
   * Get partner propagator.
   */
   template <class QT>
   const QT& PropagatorTmpl<QT>::partner() 
   const
   {
      UTIL_CHECK(partnerPtr_);
      return *partnerPtr_;
   }
 
}
#endif