rpc/environment/FilmFieldGenMask.h

#ifndef RPC_MASK_GEN_FILM_H
#define RPC_MASK_GEN_FILM_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 <rpc/system/System.h>
#include <prdc/environment/FilmFieldGenMaskBase.h>  // Base class
 
namespace Pscf {
namespace Rpc {
 
   using namespace Util;
   using namespace Pscf::Prdc;

   template <int D>
   class FilmFieldGenMask : public FilmFieldGenMaskBase<D>
   {
 
   public:

      FilmFieldGenMask();
      
      FilmFieldGenMask(System<D>& sys);

      ~FilmFieldGenMask();

      double stress(int paramId) const;

      double modifyStress(int paramId, double stress) const;
 
      using FilmFieldGenMaskBase<D>::normalVecId;
      using FilmFieldGenMaskBase<D>::interfaceThickness;
      using FilmFieldGenMaskBase<D>::excludedThickness;
      using FilmFieldGenMaskBase<D>::hasFBulk;
 
   protected:

      void compute();

      void setFlexibleParams() const;

      System<D>& system();

      System<D> const & system() const;

      std::string systemSpaceGroup() const;

      RealVec<D> systemLatticeVector(int id) const;
 
      using FilmFieldGenMaskBase<D>::modifyFlexibleParams;
      using FilmFieldGenMaskBase<D>::normalVecCurrent_;
      using FilmFieldGenMaskBase<D>::fBulk_;
      using ParamComposite::setClassName;
 
   private:

      System<D>* sysPtr_;
 
   };
 
   // Inline member functions
 
   // Get parent System by non-const reference.
   template <int D>
   System<D>& FilmFieldGenMask<D>::system() 
   {
      UTIL_CHECK(sysPtr_);  
      return *sysPtr_; 
   }
 
   // Get parent System by const reference.
   template <int D>
   System<D> const & FilmFieldGenMask<D>::system() const
   {  
      UTIL_CHECK(sysPtr_);  
      return *sysPtr_; 
   }
 
   // Get space group name for this system.
   template <int D>
   inline std::string FilmFieldGenMask<D>::systemSpaceGroup() const
   {  return system().domain().groupName(); }
 
   // Get one of the lattice vectors for this system.
   template <int D>
   inline RealVec<D> FilmFieldGenMask<D>::systemLatticeVector(int id) const
   {  return system().domain().unitCell().rBasis(id); }
 
   // Explicit instantiation declarations
   extern template class FilmFieldGenMask<1>;
   extern template class FilmFieldGenMask<2>;
   extern template class FilmFieldGenMask<3>;
 
} // namespace Rpc
} // namespace Pscf
 
#endif