rpg/fts/compressor/Compressor.h

#ifndef RPG_COMPRESSOR_H
#define RPG_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 Rpg {
 
   template <int D> class System;
 
   using namespace Util;

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

      Compressor();

      Compressor(System<D>& system);

      virtual ~Compressor() = default;

      virtual int compress() = 0;
      
      int mdeCounter() const;
      
      virtual void outputTimers(std::ostream& out) const = 0;
      
      virtual void clearTimers() = 0;
      
   protected:

      int mdeCounter_;

      void setSystem(System<D>& system);

      System<D> const & system() const;
      
      System<D>& system();
      
   private:

      System<D>* sysPtr_;
 
   };
 
   // Inline member functions
 
   /*
   * Return parent system by const reference.
   */
   template <int D> inline
   System<D> const & Compressor<D>::system() const
   {  
      UTIL_ASSERT(sysPtr_);
      return *sysPtr_;
   }
 
   /*
   * Return parent system by non-const reference.
   */
   template <int D> inline
   System<D>& Compressor<D>::system()
   {  
      UTIL_ASSERT(sysPtr_);
      return *sysPtr_;
   }
 
   // Non-inline 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"); }
 
   /*
   * Get number of times MDE has been solved.
   */
   template <int D>
   int Compressor<D>::mdeCounter() const
   {  return mdeCounter_; }
 
   // Protected function
  
   /*
   * Create association with the parent system.
   */
   template <int D>
   void Compressor<D>::setSystem(System<D>& system)
   {
      UTIL_CHECK(!sysPtr_);
      sysPtr_ = &system; 
   }
 
} // namespace Rpg
} // namespace Pscf
#endif