rpg/field/Mask.h

#ifndef RPG_MASK_H
#define RPG_MASK_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 "FieldIo.h"              // parent class template parameter
#include <prdc/cuda/RField.h>     // parent class template parameter
#include <prdc/field/MaskTmpl.h>  // parent class
 
namespace Pscf {
namespace Rpg {
 
   using namespace Util;
   using namespace Prdc;

   template <int D>
   class Mask
     : public Prdc::MaskTmpl< D, Cuda::RField<D>, FieldIo<D> >
   {
 
   public:

      typedef Prdc::MaskTmpl< D, Prdc::Cuda::RField<D>, FieldIo<D> > Base;
 
      // Inherited public member functions
      using Base::setFieldIo;
      using Base::allocateBasis;
      using Base::allocateRGrid;
      using Base::setBasis;
      using Base::setRGrid;
      using Base::readBasis;
      using Base::readRGrid;
      using Base::writeBasis;
      using Base::writeRGrid;
      using Base::basis;
      using Base::rgrid;
      using Base::phiTot;
      using Base::isAllocatedBasis;
      using Base::isAllocatedRGrid;
      using Base::hasData;
      using Base::isSymmetric;
 
   protected:
 
      using Base::meshDimensions;
      using Base::meshSize;
      using Base::nBasis;
      using Base::fieldIo;

      double rGridAverage() const override;
 
   };
 
   // Explicit instantiation declarations
   extern template class Mask<1>;
   extern template class Mask<2>;
   extern template class Mask<3>;
 
} // namespace Rpg
 
namespace Prdc {
   // Explicit instantiation declarations for base class template
   extern template class MaskTmpl< 1, Cuda::RField<1>, Rpg::FieldIo<1> >;
   extern template class MaskTmpl< 2, Cuda::RField<2>, Rpg::FieldIo<2> >;
   extern template class MaskTmpl< 3, Cuda::RField<3>, Rpg::FieldIo<3> >;
}
 
} // namespace Pscf
#endif