FieldGenerator.h

#ifndef PSCF_FIELD_GENERATOR_H
#define PSCF_FIELD_GENERATOR_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/ParameterModifier.h> // base class
#include <util/param/ParamComposite.h>    // base class
 
namespace Pscf {
 
   using namespace Util;
 
   class FieldGenerator : public ParamComposite, 
                          public ParameterModifier
   {
 
   public:
 
      enum Type {Mask, External, Both, None};
      
      FieldGenerator();
 
      ~FieldGenerator();
      
      void setup();
 
      void update();
 
      bool isDependent() const;
 
      virtual void checkCompatibility() = 0;
 
      virtual bool updateNeeded() const = 0;
 
      virtual bool isGenerated() const = 0;
 
      virtual double stressTerm(int paramId) const
      {  return 0.0; } 
 
      virtual double modifyStress(int paramId, double stress) const
      {  return stress; }
 
      Type type() const
      {  return type_; }
   
   protected:
 
      virtual void allocate() = 0;
 
      virtual void generate() = 0;
 
      Type type_;
 
      bool isDependent_;
 
   };
 
   // Is this object dependent on the parameters of another FieldGenerator?
   inline bool FieldGenerator::isDependent() const
   {  return isDependent_; }
 
}
#endif