fts/compressor/AmCompressor.h

#ifndef RP_AM_COMPRESSOR_H
#define RP_AM_COMPRESSOR_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 <util/containers/DArray.h>         // member
 
namespace Pscf {
namespace Rp {
 
   // Namespaces that can be used implicitly
   using namespace Util;

   template <int D, class T, class V>
   class AmCompressor 
    : public AmIteratorTmpl< typename T::Compressor, V >
   {
 
   public:

      using VectorT = V;

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

      void setup(bool isContinuation) override;

      int compress() override;

      void outputTimers(std::ostream& out) const override;

      void clearTimers() override;
 
   protected:

      AmCompressor(typename T::System& system);

      ~AmCompressor() = default;

      using CompressorT = typename T::Compressor;
 
      // Inherited protected member function
      using CompressorT::system;
 
   private:

      DArray< typename T::RField > w0_;

      DArray< typename T::RField > wFieldTmp_;

      bool isAllocated_;
 
      // Private virtual AM algorithm functions.

      int nElements() override;

      bool hasInitialGuess() override;

      void getCurrent(VectorT& curr) override;

      void evaluate() override;

      void getResidual(VectorT& resid) override;

      void update(VectorT& newGuess) override;

      void outputToLog() override;

      using AmTmpl = AmIteratorTmpl< CompressorT, VectorT >;
 
   };
 
} // namespace Rp
} // namespace Pscf
#endif