FilmFieldGenMaskBase.h

#ifndef PRDC_FILM_MASK_FG_BASE_H
#define PRDC_FILM_MASK_FG_BASE_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/environment/FieldGenerator.h>  // Base class
#include <prdc/crystal/UnitCell.h>            // Function parameter
#include <pscf/math/RealVec.h>                // container
#include <iostream>
#include <string>
 
namespace Pscf {
namespace Prdc {
 
   using namespace Util;

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

      FilmFieldGenMaskBase();

      ~FilmFieldGenMaskBase();

      void readParameters(std::istream& in);

      bool needsUpdate() const;

      void checkCompatibility();

      int normalVecId() const;

      double interfaceThickness() const;

      double excludedThickness() const;

      double fBulk() const;

      bool hasFBulk() const;

      virtual double stress(int paramId) const = 0;

      virtual double modifyStress(int paramId, double stress) const = 0;
 
   protected:

      virtual void compute() = 0;

      void checkSpaceGroup() const;

      void checkLatticeVectors() const;

      FSArray<bool,6> modifyFlexibleParams(FSArray<bool,6> current,
                                           UnitCell<D> const & cell) const;

      virtual void setFlexibleParams() const = 0;

      virtual std::string systemSpaceGroup() const = 0;

      virtual RealVec<D> systemLatticeVector(int id) const = 0;

      RealVec<D> normalVecCurrent_;

      double fBulk_;
 
      using ParamComposite::read;
      using ParamComposite::readOptional;
 
   private:

      int normalVecId_;

      double interfaceThickness_;

      double excludedThickness_;

      bool hasFBulk_;
 
      using FieldGenerator::type_;
 
   };
 
   // Inline member functions
 
   // Get value of normalVecId.
   template <int D> 
   inline int FilmFieldGenMaskBase<D>::normalVecId() const
   {  return normalVecId_; }
 
   // Get value of interfaceThickness.
   template <int D> 
   inline double FilmFieldGenMaskBase<D>::interfaceThickness() const
   {  return interfaceThickness_; }
 
   // Get value of excludedThickness.
   template <int D> 
   inline double FilmFieldGenMaskBase<D>::excludedThickness() const
   {  return excludedThickness_; }
 
   // Get value of fBulk.
   template <int D> 
   inline double FilmFieldGenMaskBase<D>::fBulk() const
   {  return fBulk_; }
 
   // Check whether a value of fBulk was provided.
   template <int D> 
   inline bool FilmFieldGenMaskBase<D>::hasFBulk() const
   {  return hasFBulk_; }
 
   #ifndef PRDC_MASK_GEN_FILM_BASE_TPP
   // Suppress implicit instantiation
   extern template class FilmFieldGenMaskBase<1>;
   extern template class FilmFieldGenMaskBase<2>;
   extern template class FilmFieldGenMaskBase<3>;
   #endif
 
}
}
#endif