EnvironmentBase.h

#ifndef PSCF_ENVIRONMENT_BASE_H
#define PSCF_ENVIRONMENT_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 EnvironmentBase : public ParamComposite, public ParameterModifier
   {
 
   public:

      EnvironmentBase();

      ~EnvironmentBase();

      virtual void generate() = 0;

      virtual void reset();

      bool needsUpdate() const;

      bool generatesMask() const;

      bool generatesExternalFields() const;
 
      using ParamComposite::setClassName;
 
   protected:

      void setNeedsUpdateFalse();

      void setGenerateBools(bool generatesMask, bool generatesExt);
 
   private:

      bool needsUpdate_;

      bool generatesMask_;

      bool generatesExternalFields_;

      bool boolsSet_;
      
   };
 
   // Member functions
 
   // Constructor
   inline EnvironmentBase::EnvironmentBase()
    : needsUpdate_(true),
      generatesMask_(false),
      generatesExternalFields_(false),
      boolsSet_(false)
   {  setClassName("EnvironmentBase"); }
 
   // Destructor
   inline EnvironmentBase::~EnvironmentBase()
   {}
 
   // Sets needsUpdate() to true. 
   inline void EnvironmentBase::reset()
   {  needsUpdate_ = true; }
 
   // Does this Environment need to be updated?
   inline bool EnvironmentBase::needsUpdate() const
   {  return needsUpdate_; }
 
   // Does this Environment generate a mask?
   inline bool EnvironmentBase::generatesMask() const
   {  return generatesMask_; }
 
   // Does this Environment generate external fields?
   inline bool EnvironmentBase::generatesExternalFields() const
   {  return generatesExternalFields_; }
 
   // Set needsUpdate to false.
   inline void EnvironmentBase::setNeedsUpdateFalse()
   {  
      if (!boolsSet_) {
         UTIL_THROW("Must call setGenerateBools before generating fields.");
      }
      needsUpdate_ = false; 
   }
 
   // Set generatesMask and generatesExternalFields.
   inline void EnvironmentBase::setGenerateBools(bool generatesMask, 
                                                 bool generatesExt)
   {  
      UTIL_CHECK(!boolsSet_);
      generatesMask_ = generatesMask;
      generatesExternalFields_ = generatesExt;
      boolsSet_ = true;
   }
 
} // namespace Pscf
#endif