FilmFieldGenExtBase.h

#ifndef PRDC_FILM_FIELD_GEN_EXT_BASE_H
#define PRDC_FILM_FIELD_GEN_EXT_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 <pscf/math/RealVec.h>                // member
#include <util/containers/DArray.h>           // member
 
#include <string>
 
// Forward declarations
namespace Util {
  template <typename T> class GArray;
}
namespace Pscf {
  struct ParameterType;
}
 
 
namespace Pscf {
namespace Prdc {
 
   using namespace Util;

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

      FilmFieldGenExtBase();

      ~FilmFieldGenExtBase();

      void readParameters(std::istream& in);

      bool needsUpdate() const;

      void checkCompatibility();

      bool hasSymmetricWalls() const;

      bool isAthermal() const;

      GArray<ParameterType> getParameterTypes();

      void setParameter(std::string name, DArray<int> ids, double value, 
                        bool& success);

      double getParameter(std::string name, DArray<int> ids, bool& success) 
      const;

      DArray<double> const & chiBottom() const;

      DArray<double> const & chiTop() const;

      double chiBottom(int s) const;

      double chiTop(int s) const;

      int normalVecId() const;

      double interfaceThickness() const;

      double excludedThickness() const;

      virtual double stress(int paramId) const = 0;
 
      using ParameterModifier::setParameter; // overloaded method
      using ParameterModifier::getParameter; // overloaded method
 
   protected:

      virtual void compute() = 0;

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

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

      virtual int systemNMonomer() const = 0;

      RealVec<D> normalVecCurrent_;

      DArray<double> chiBottomCurrent_;

      DArray<double> chiTopCurrent_;
 
      using FieldGenerator::isDependent_;
      using FieldGenerator::type_;
 
   private:

      int normalVecId_;

      double interfaceThickness_;

      double excludedThickness_;

      DArray<double> chiBottom_;

      DArray<double> chiTop_;
 
   };
 
   // Inline member functions
 
   // Get chiBottom array by const reference
   template <int D>
   inline DArray<double> const & FilmFieldGenExtBase<D>::chiBottom() const
   {  return chiBottom_; }
 
   // Get chiTop array by const reference
   template <int D>
   inline DArray<double> const & FilmFieldGenExtBase<D>::chiTop() const
   {  return chiTop_; }
 
   // Get the chi parameter between the bottom wall and species s
   template <int D>
   inline double FilmFieldGenExtBase<D>::chiBottom(int s) const
   {  return chiBottom_[s]; }
 
   // Get the chi parameter between the top wall and species s
   template <int D>
   inline double FilmFieldGenExtBase<D>::chiTop(int s) const
   {  return chiTop_[s]; }
 
   // Get value of normalVecId.
   template <int D> 
   inline int FilmFieldGenExtBase<D>::normalVecId() const
   {  return normalVecId_; }
 
   // Get value of interfaceThickness.
   template <int D> 
   inline double FilmFieldGenExtBase<D>::interfaceThickness() const
   {  return interfaceThickness_; }
 
   // Get value of excludedThickness.
   template <int D> 
   inline double FilmFieldGenExtBase<D>::excludedThickness() const
   {  return excludedThickness_; }
 
   #ifndef PRDC_FILM_FIELD_GEN_EXT_BASE_TPP
   // Suppress implicit instantiation
   extern template class FilmFieldGenExtBase<1>;
   extern template class FilmFieldGenExtBase<2>;
   extern template class FilmFieldGenExtBase<3>;
   #endif
 
}
}
#endif