ExtGenFilmBase.h

#ifndef PRDC_EXT_GEN_FILM_BASE_H
#define PRDC_EXT_GEN_FILM_BASE_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 <pscf/sweep/ParameterType.h>      // Return type of method
#include <pscf/iterator/FieldGenerator.h>  // Base class
#include <pscf/math/RealVec.h>       // Container
#include <util/containers/DArray.h>  // Container
#include <string>
 
 
 
namespace Pscf {
namespace Prdc {
 
   using namespace Util;
 
   template <int D>
   class ExtGenFilmBase : public FieldGenerator
   {
 
   public:
 
      ExtGenFilmBase();
 
      ~ExtGenFilmBase();
 
      void readParameters(std::istream& in);
 
      void checkCompatibility();
 
      bool updateNeeded() const;
 
      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;
 
      bool isGenerated() const = 0;
 
      virtual double stressTerm(int paramId) const = 0;
 
      using ParameterModifier::setParameter; // overloaded method
      using ParameterModifier::getParameter; // overloaded method
 
   protected:
 
      virtual void allocate() = 0;
 
      virtual void generate() = 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 & ExtGenFilmBase<D>::chiBottom() const
   {  return chiBottom_; }
 
   // Get chiTop array by const reference
   template <int D>
   inline DArray<double> const & ExtGenFilmBase<D>::chiTop() const
   {  return chiTop_; }
 
   // Get the chi parameter between the bottom wall and species s
   template <int D>
   inline double ExtGenFilmBase<D>::chiBottom(int s) const
   {  return chiBottom_[s]; }
 
   // Get the chi parameter between the top wall and species s
   template <int D>
   inline double ExtGenFilmBase<D>::chiTop(int s) const
   {  return chiTop_[s]; }
 
   // Get value of normalVecId.
   template <int D> 
   inline int ExtGenFilmBase<D>::normalVecId() const
   {  return normalVecId_; }
 
   // Get value of interfaceThickness.
   template <int D> 
   inline double ExtGenFilmBase<D>::interfaceThickness() const
   {  return interfaceThickness_; }
 
   // Get value of excludedThickness.
   template <int D> 
   inline double ExtGenFilmBase<D>::excludedThickness() const
   {  return excludedThickness_; }
 
}
}
 
#include "ExtGenFilmBase.tpp"
#endif