fts/ramp/RampParameter.h

#ifndef RP_RAMP_PARAMETER_H
#define RP_RAMP_PARAMETER_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/containers/DArray.h>         // member
#include <util/global.h>
 
#include <iostream>
#include <string>
 
namespace Pscf {
namespace Rp {
 
   using namespace Util;

   template <int D, class T>
   class RampParameter
   {
 
   public:
 
      // Protected constructor and destructor (see below).

      void setSimulator(typename T::Simulator& simulator);

      void getInitial();

      void update(double newVal);

      std::string type() const;

      void writeParamType(std::ostream& out) const;

      int id(int i) const
      {
         UTIL_CHECK(i < nId_);
         return id_[i];
      }

      int nId() const
      {  return nId_; }

      double current()
      {  return get_(); }

      double initial() const
      {  return initial_; }

      double change() const
      {  return change_; }

      template <class Archive>
      void serialize(Archive ar, const unsigned int version);
 
   protected:

      RampParameter();

      RampParameter(typename T::Simulator& simulator);

      ~RampParameter() = default;
 
   private:

      enum ParamType { Block, Chi, Kuhn, Phi_Polymer, Phi_Solvent,
                       Mu_Polymer, Mu_Solvent, Solvent, Cell_Param,
                       Lambda_Pert, Vmonomer, Null};

      ParamType type_;

      int nId_;

      DArray<int> id_;

      double initial_;

      double change_;

      typename T::Simulator* simulatorPtr_;

      typename T::System* systemPtr_;

      void readParamType(std::istream& in);

      double get_();

      void set_(double newVal);
 
   // friends:
 
      template <int U, class V>
      friend
      std::istream& operator >> (std::istream&, RampParameter<U,V>&);
 
      template <int U, class V>
      friend
      std::ostream& operator << (std::ostream&, RampParameter<U,V> const&);
 
   };

   template <int D, class T>
   std::istream& operator >> (std::istream& in,
                              RampParameter<D,T>& param);

   template <int D, class T>
   std::ostream& operator << (std::ostream& out,
                              RampParameter<D,T> const & param);
 
   // Function definitions (implicitly instantiated)
 
   template <int D, class T>
   template <class Archive>
   void RampParameter<D,T>::serialize(Archive ar, 
                                      const unsigned int version)
   {
      serializeEnum(ar, type_, version);
      ar & nId_;
      if (nId_ > 0) {
         for (int i = 0; i < nId_; ++i) {
            ar & id_[i];
         }
      }
      ar & initial_;
      ar & change_;
   }
 
   /*
   * Inserter for reading a RampParameter from an istream.
   */
   template <int D, class T>
   std::istream& operator >> (std::istream& in,
                              RampParameter<D,T>& param)
   {
      // Read the parameter type identifier string
      param.readParamType(in);
 
      // Read the identifiers associated with this parameter type.
      if (param.nId_ > 0) {
         for (int i = 0; i < param.nId_; ++i) {
            in >> param.id_[i];
         }
      }
 
      // Read in the range in the parameter to sweep over
      in >> param.change_;
 
      return in;
   }
 
   /*
   * Extractor for writing a RampParameter to ostream.
   */
   template <int D, class T>
   std::ostream& operator << (std::ostream& out,
                              RampParameter<D,T> const & param)
   {
      param.writeParamType(out);
      out << "  ";
      if (param.nId_ > 0) {
         for (int i = 0; i < param.nId_; ++i) {
            out << param.id(i);
            out << " ";
         }
      }
      out << param.change_;
 
      return out;
   }
 
}
}
#endif