rpg/fts/compressor/LrAmCompressor.h

#ifndef RPG_LR_AM_COMPRESSOR_H
#define RPG_LR_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"                          // base class argument
#include <pscf/cuda/DeviceArray.h>               // base class argument
#include <pscf/iterator/AmIteratorTmpl.h>        // base class template
 
#include <rpg/fts/compressor/IntraCorrelation.h> // member
#include <prdc/cpu/RField.h>                     // member
#include <prdc/cpu/RFieldDft.h>                  // member
#include <util/containers/DArray.h>              // member
 
#include <iostream>                 
 
namespace Pscf {
namespace Rpg {
 
   // Forward declaration
   template <int D> class System;
 
   using namespace Util;
   using namespace Pscf::Prdc;
   using namespace Pscf::Prdc::Cuda;

   template <int D>
   class LrAmCompressor 
         : public AmIteratorTmpl<Compressor<D>, DeviceArray<cudaReal> >
   {
 
   public:

      using VectorT = DeviceArray<cudaReal>;

      LrAmCompressor(System<D>& system);

      ~LrAmCompressor();

      void readParameters(std::istream& in);
 
      void setup(bool isContinuation);      
      
      int compress();    
      
      void outputTimers(std::ostream& out) const;

      void clearTimers();
 
   private:
   
      int itr_;
      
      DArray< RField<D> > w0_;  
      
      DArray< RField<D> > wFieldTmp_;
      
      RField<D> resid_;
      
      RFieldDft<D> residK_;
     
      RField<D> intraCorrelationK_;
       
      IntVec<D> kMeshDimensions_;
      
      int kSize_;

      bool isIntraCalculated_;
      
      IntraCorrelation<D> intra_;
      
      bool isAllocated_;
   
      // AM algorithm operations
    
      void addCorrection(VectorT& fieldTrial, 
                         VectorT const & resTrial) override;
 
      
      // Private virtual that interact with the parent System
      
      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;
 
      // Private virtual functions for vector math
      
      void setEqual(VectorT& a, 
                    VectorT const & b) override;

      double dotProduct(VectorT const & a, 
                        VectorT const & b) override;

      double maxAbs(VectorT const & hist) override;

      void subVV(VectorT& a, 
                 VectorT const & b, 
       VectorT const & c) override;

      void addEqVc(VectorT& a, 
         VectorT const & b, 
                   double c) override;
 
      // Inherited private member
      using Compressor<D>::system;

      using Base = AmIteratorTmpl< Compressor<D>, VectorT >;
   };
   
   // Explicit instantiation declarations
   extern template class LrAmCompressor<1>;
   extern template class LrAmCompressor<2>;
   extern template class LrAmCompressor<3>;
 
} // namespace Rpg
} // namespace Pscf
#endif