pspc/field/KFieldComparison.h

#ifndef PSPC_K_FIELD_COMPARISON_H
#define PSPC_K_FIELD_COMPARISON_H
 
/*
* PSCF - Polymer Self-Consistent Field Theory
*
* Copyright 2016 - 2022, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include <util/containers/DArray.h>
#include <pspc/field/RFieldDft.h>
 
namespace Pscf {
namespace Pspc {
 
   using namespace Util;
 
   template <int D>
   class KFieldComparison {
 
   public:
 
      KFieldComparison();
 
      // Use compiler defined destructor and assignment operator.
 
      double compare(RFieldDft<D> const& a, RFieldDft<D> const& b);
 
      double compare(DArray<RFieldDft<D> > const& a, 
                     DArray<RFieldDft<D> > const& b);
 
      double maxDiff() const
      {  return maxDiff_; }
   
      double rmsDiff() const
      {  return rmsDiff_; }
   
   private:
  
      // Maximum element-by-element difference. 
      double maxDiff_;
 
      // Room-mean-squared element-by-element difference. 
      double rmsDiff_;
   
   };
 
   #ifndef PSPC_K_FIELD_COMPARISON_TPP
   // Suppress implicit instantiation
   extern template class KFieldComparison<1>;
   extern template class KFieldComparison<2>;
   extern template class KFieldComparison<3>;
   #endif
 
 
} // namespace Pspc
} // namespace Pscf
#endif