AmIterator.h

#ifndef R1D_AM_ITERATOR_H
#define R1D_AM_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 <pscf/iterator/AmIteratorTmpl.h>   // base class template
#include <r1d/iterator/Iterator.h>          // base class template argument
#include <util/containers/DArray.h>         // base class template argument
#include <pscf/iterator/AmbdInteraction.h>  // member
 
namespace Pscf {
namespace R1d {
 
   // Forward declaration
   class System;
 
   using namespace Util;

   class AmIterator : public AmIteratorTmpl<Iterator, DArray<double> >
   {
 
   public:

      AmIterator(System& system);

      ~AmIterator();

      void readParameters(std::istream& in) override;
 
   protected:

      void setup(bool isContinuation) override;
 
   private:

      AmbdInteraction interaction_;
 
      // Non-virtual private function

      bool isCanonical();
 
      // Private virtual functions that interact with parent System 

      int nElements() override;

      bool hasInitialGuess() override;

      void getCurrent(DArray<double>& curr) override;

      void evaluate() override;

      void getResidual(DArray<double>& resid) override;

      void update(DArray<double>& newGuess) override;

      void outputToLog() override;
 
   };
 
} // namespace R1d
} // namespace Pscf
 
// Explicit instantiation declaration
namespace Pscf {
   extern template class AmIteratorTmpl< R1d::Iterator, DArray<double> >;
}
#endif