SolventSpecies.h

#ifndef PSCF_SOLVENT_DESCRIPTOR_H
#define PSCF_SOLVENT_DESCRIPTOR_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/chem/Species.h>             // base class
#include <util/param/ParamComposite.h>     // base class
 
namespace Pscf {
 
   using namespace Util;
 
   class SolventSpecies : public Species, public ParamComposite
   {
 
   public:
 
      SolventSpecies();
 
      ~SolventSpecies();
 
      virtual void readParameters(std::istream& in);
 
 
      void setPhi(double phi);
 
      void setMu(double mu);
 
      void setMonomerId(int monomerId);
 
      void setSize(double size);
 
 
      int monomerId() const;
 
      double size() const;
 
 
      // Inherited accessor functions
      using Pscf::Species::phi;
      using Pscf::Species::mu;
      using Pscf::Species::q;
      using Pscf::Species::ensemble;
 
   protected:
 
      // Inherited data members
      using Pscf::Species::phi_;
      using Pscf::Species::mu_;
      using Pscf::Species::q_;
      using Pscf::Species::ensemble_;
 
      int monomerId_;
 
      double size_;
 
   };
 
   // Inline member functions
 
   /*
   * Get the monomer type id.
   */
   inline int SolventSpecies::monomerId() const
   {  return monomerId_; }
 
   /*
   * Get the size (number of monomers) in this block.
   */
   inline double SolventSpecies::size() const
   {  return size_; }
 
}
#endif