rpc/fts/compressor/AmCompressor.h

#ifndef RPC_AM_COMPRESSOR_H
#define RPC_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 "Compressor.h"
#include <prdc/cpu/RField.h>
#include <pscf/iterator/AmIteratorTmpl.h>
 
namespace Pscf {
namespace Rpc
{
 
   template <int D>
   class System;
 
   using namespace Util;
   using namespace Pscf::Prdc::Cpu;

   template <int D>
   class AmCompressor
         : public AmIteratorTmpl<Compressor<D>, DArray<double> >
   {
 
   public:

      AmCompressor(System<D>& system);

      ~AmCompressor();

      void readParameters(std::istream& in);

      void setup(bool isContinuation);

      int compress();

      double computeLambda(double r);

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

      void clearTimers();
 
      // Inherited public member functions
      using AmIteratorTmpl<Compressor<D>, DArray<double> >::setClassName;
 
   protected:
 
      // Inherited protected members
      using ParamComposite::readOptional;
      using Compressor<D>::mdeCounter_;
 
   private:

      int itr_;

      DArray< RField<D> > w0_;

      bool isAllocated_;

      DArray< RField<D> > wFieldTmp_;

      DArray<double> newBasis_;

      void setEqual(DArray<double>& a, DArray<double> const & b);

      double dotProduct(DArray<double> const & a, DArray<double> const & b);

      double maxAbs(DArray<double> const & hist);

      void updateBasis(RingBuffer<DArray<double> > & basis,
                       RingBuffer<DArray<double> > const & hists);

      void addHistories(DArray<double>& trial,
                        RingBuffer<DArray<double> > const & basis,
                        DArray<double> coeffs,
                        int nHist);

      void addPredictedError(DArray<double>& fieldTrial,
                             DArray<double> const & resTrial,
                             double lambda);

      bool hasInitialGuess();

      int nElements();

      void getCurrent(DArray<double>& curr);

      void evaluate();

      void getResidual(DArray<double>& resid);

      void update(DArray<double>& newGuess);

      void outputToLog();
 
      // Inherited private members
      using Compressor<D>::system;
 
   };
 
   #ifndef RPC_AM_COMPRESSOR_TPP
   // Suppress implicit instantiation
   extern template class AmCompressor<1>;
   extern template class AmCompressor<2>;
   extern template class AmCompressor<3>;
   #endif
 
} // namespace Rpc
} // namespace Pscf
#endif