rp/scft/iterator/Iterator.h

#ifndef RP_ITERATOR_H
#define RP_ITERATOR_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/containers/FSArray.h>      // member
#include <util/global.h>
 
namespace Pscf {
namespace Rp {
 
   using namespace Util;

   template <int D, class ST>
   class Iterator : public ParamComposite
   {
 
   public:

      virtual int solve(bool isContinuation) = 0;

      virtual void outputTimers(std::ostream& out) const = 0;

      virtual void clearTimers() = 0;

      bool isSymmetric() const
      {  return (isSymmetric_); }

      bool isFlexible() const
      {  return (isFlexible_); }

      FSArray<bool,6> flexibleParams() const
      {  return flexibleParams_; }

      int nFlexibleParams() const;

      void setFlexibleParams(FSArray<bool,6> const & flexParams);

      virtual double stress(int paramId) const;
 
   protected:

      bool isSymmetric_;

      bool isFlexible_;

      FSArray<bool,6> flexibleParams_;
 
      // Protected member functions

      Iterator();

      Iterator(ST& system);

      ~Iterator();

      void setSystem(ST& system);

      ST const & system() const;

      ST& system();
 
   private:

      ST* sysPtr_;
 
   };
 
   // Inline member functions

   template <int D, class ST> inline
   ST const & Iterator<D, ST>::system() const
   {
      UTIL_CHECK(sysPtr_);
      return *sysPtr_;
   }

   template <int D, class ST> inline
   ST& Iterator<D, ST>::system()
   {
      UTIL_CHECK(sysPtr_);
      return *sysPtr_;
   }
 
} // namespace Rp
} // namespace Pscf
#endif