rpc/fts/ramp/RampParameter.h

#ifndef RPC_RAMP_PARAMETER_H
#define RPC_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 <iostream>
#include <string>
 
namespace Pscf {
namespace Rpc {
 
   template <int D> class Simulator;
   template <int D> class System;

   template <int D>
   class RampParameter
   {
 
   public:

      RampParameter();

      RampParameter(Simulator<D>& simulator);

      void setSimulator(Simulator<D>& 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);
 
   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_;

      Simulator<D>* simulatorPtr_;

      System<D>* systemPtr_;

      void readParamType(std::istream& in);

      double get_();

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

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

   template <int D>
   std::ostream& operator << (std::ostream& out, 
                              RampParameter<D> const & param);
 
}
}
#include "RampParameter.tpp"
#endif