rpc/fts/compressor/LrAmCompressor.h

#ifndef RPC_LR_AM_COMPRESSOR_H
#define RPC_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/iterator/AmIteratorDArray.h>       // base class template
 
#include <rpc/fts/compressor/IntraCorrelation.h>  // member
#include <prdc/cpu/RField.h>                      // member
#include <prdc/cpu/RFieldDft.h>                   // member
#include <util/containers/DArray.h>               // member
 
 
namespace Pscf {
namespace Rpc {
 
   // Forward declaration
   template <int D> class System;
 
   using namespace Util;
   using namespace Pscf::Prdc;
   using namespace Pscf::Prdc::Cpu;

   template <int D>
   class LrAmCompressor
    : public AmIteratorDArray< Compressor<D> >
   {
 
   public:
 

      LrAmCompressor(System<D>& system);

      ~LrAmCompressor();

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

      void setup(bool isContinuation) override;
 

      int compress() override;

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

      void clearTimers() override;
 
   private:

      int itr_;

      DArray< RField<D> > w0_;

      DArray< RField<D> > wFieldTmp_;

      DArray<double> newBasis_;

      RField<D> resid_;

      RFieldDft<D> residK_;

      RField<D> intraCorrelationK_;

      IntVec<D> kMeshDimensions_;

      IntraCorrelation<D> intra_;

      bool isIntraCalculated_;

      bool isAllocated_;

      void addCorrection(DArray<double>& fieldTrial,
                         DArray<double> const & resTrial) override;
 
      // 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;
 
      // Indirect (grandparent) base class.
      using AmTmpl = AmIteratorTmpl<Compressor<D>, DArray<double> >;
 
      // Inherited private members
      using Compressor<D>::system;
 
   };
 
   // Explicit instantiation declarations
   extern template class LrAmCompressor<1>;
   extern template class LrAmCompressor<2>;
   extern template class LrAmCompressor<3>;
 
} // namespace Rpc
} // namespace Pscf
#endif