rpc/scft/iterator/MaskGenFilm.h

#ifndef RPC_MASK_GEN_FILM_H
#define RPC_MASK_GEN_FILM_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 <rpc/System.h>
#include <prdc/iterator/MaskGenFilmBase.h>  // Base class
 
namespace Pscf {
namespace Rpc {
 
   using namespace Util;
   using namespace Pscf::Prdc;
 
   template <int D>
   class MaskGenFilm : public MaskGenFilmBase<D>
   {
 
   public:
 
      MaskGenFilm();
      
      MaskGenFilm(System<D>& sys);
 
      ~MaskGenFilm();
 
      bool isGenerated() const;
 
      double stressTerm(int paramId) const;
 
      double modifyStress(int paramId, double stress) const;
 
      using MaskGenFilmBase<D>::normalVecId;
      using MaskGenFilmBase<D>::interfaceThickness;
      using MaskGenFilmBase<D>::excludedThickness;
      using MaskGenFilmBase<D>::hasFBulk;
 
   protected:
 
      void allocate();
 
      void generate();
 
      void setFlexibleParams() const;
 
      System<D>& system();
      System<D> const & system() const;
 
      std::string systemSpaceGroup() const;
 
      RealVec<D> systemLatticeVector(int id) const;
 
      using MaskGenFilmBase<D>::modifyFlexibleParams;
      using MaskGenFilmBase<D>::normalVecCurrent_;
      using MaskGenFilmBase<D>::fBulk_;
      using ParamComposite::setClassName;
 
   private:
 
      System<D>* sysPtr_;
 
   };
 
   // Inline member functions
 
   // Check whether the field has been generated
   template <int D>
   inline bool MaskGenFilm<D>::isGenerated() const
   {  return system().mask().hasData(); }
 
   // Get parent System by non-const reference.
   template <int D>
   System<D>& MaskGenFilm<D>::system() 
   {  return *sysPtr_; }
 
   // Get parent System by const reference.
   template <int D>
   System<D> const & MaskGenFilm<D>::system() const
   {  return *sysPtr_; }
 
   // Get space group name for this system.
   template <int D>
   inline std::string MaskGenFilm<D>::systemSpaceGroup() const
   {  return system().domain().groupName(); }
 
   // Get one of the lattice vectors for this system.
   template <int D>
   inline RealVec<D> MaskGenFilm<D>::systemLatticeVector(int id) const
   {  return system().domain().unitCell().rBasis(id); }
 
   #ifndef RPC_MASK_GEN_FILM_TPP
   extern template class MaskGenFilm<1>;
   extern template class MaskGenFilm<2>;
   extern template class MaskGenFilm<3>;
   #endif
 
} // namespace Rpc
} // namespace Pscf
 
#endif