cpu/RField.h

#ifndef PRDC_CPU_R_FIELD_H
#define PRDC_CPU_R_FIELD_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 <prdc/cpu/FftwDArray.h>    // base class
#include <pscf/math/IntVec.h>       // member
 
namespace Pscf {
namespace Prdc {
namespace Cpu {
 
   using namespace Util;

   template <int D>
   class RField : public FftwDArray<double>
   {
 
   public:
 
      // Public type alias 
 
      using FftwDArray<double>::ValueType;
 
      // Public member functions

      RField();

      RField(const RField& other);

      virtual ~RField();

      RField& operator = (const RField& other);

      void allocate(IntVec<D> const & meshDimensions);

      virtual void deallocate();

      const IntVec<D>& meshDimensions() const;

      template <class Archive>
      void serialize(Archive& ar, const unsigned int version);
 
   private:
 
      // Vector containing number of grid points in each direction.
      IntVec<D> meshDimensions_;
 
      using FftwDArray<double>::allocate;
 
   };
 
   /*
   * Return mesh dimensions by constant reference.
   */
   template <int D>
   inline const IntVec<D>& RField<D>::meshDimensions() const
   {  return meshDimensions_; }
 
   /*
   * Serialize a Field to/from an Archive.
   */
   template <int D>
   template <class Archive>
   void RField<D>::serialize(Archive& ar, const unsigned int version)
   {
      FftwDArray<double>::serialize(ar, version);
      ar & meshDimensions_;
   }
 
   // Explicit instantiation declarations
   extern template class RField<1>;
   extern template class RField<2>;
   extern template class RField<3>;
 
} // namespace Cpu
} // namespace Prdc
} // namespace Pscf
#endif