FieldGeneratorBase.h

#ifndef PSCF_FIELD_GENERATOR_BASE_H
#define PSCF_FIELD_GENERATOR_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 <util/param/ParamComposite.h>    // base class
#include <pscf/sweep/ParameterModifier.h> // base class
 
namespace Pscf {
 
   using namespace Util;

   class FieldGeneratorBase : public ParamComposite, 
                              public ParameterModifier
   {
 
   public:

      enum Type {Mask, External, None};
      
      FieldGeneratorBase();

      ~FieldGeneratorBase();
      
      void generate();

      virtual bool needsUpdate() const = 0;

      virtual void checkCompatibility() = 0;

      Type type() const;

      bool isDependent() const;
   
   protected:

      virtual void compute() = 0;

      Type type_;

      bool isDependent_;
 
   };
 
   // Inline member functions
 
   // Return Type enumeration value (Mask, External, or None)
   inline FieldGeneratorBase::Type FieldGeneratorBase::type() const
   {  return type_; }
 
   // Is this object dependent on parameters of another FieldGeneratorBase?
   inline bool FieldGeneratorBase::isDependent() const
   {  return isDependent_; }
 
}
#endif