rpc/fts/compressor/Compressor.h

#ifndef RPC_COMPRESSOR_H
#define RPC_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 <util/param/ParamComposite.h>    // base class
#include <util/global.h>
 
namespace Pscf {
namespace Rpc
{
 
   template <int D> class System;
 
   using namespace Util;

   template <int D>
   class Compressor : public ParamComposite
   {
 
   public:

      Compressor();

      Compressor(System<D>& system);

      ~Compressor();

      virtual int compress() = 0;

      virtual void outputTimers(std::ostream& out) const = 0;

      virtual void clearTimers() = 0;

      int mdeCounter() const;
 
   protected:

      System<D> const & system() const
      {  
         UTIL_ASSERT(sysPtr_);
         return *sysPtr_;
      }

      System<D>& system()
      {  
         UTIL_ASSERT(sysPtr_);
         return *sysPtr_;
      }

      int mdeCounter_;
 
   private:

      System<D>* sysPtr_;
 
   };
 
   // Member functions
 
   // Default constructor.
   template <int D>
   Compressor<D>::Compressor()
    : mdeCounter_(0),
      sysPtr_(nullptr)
   {  setClassName("Compressor"); }
 
   // Constructor.
   template <int D>
   Compressor<D>::Compressor(System<D>& system)
    : mdeCounter_(0),
      sysPtr_(&system)
   {  setClassName("Compressor"); }
 
   // Destructor
   template <int D>
   Compressor<D>::~Compressor()
   {}
 
   // Get number of times MDE has been solved.
   template <int D>
   inline int Compressor<D>::mdeCounter() const
   {  return mdeCounter_; }
 
} // namespace Rpc
} // namespace Pscf
#endif