rpc/solvers/Solvent.h

#ifndef RPC_SOLVENT_H
#define RPC_SOLVENT_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 <pscf/chem/SolventSpecies.h>   // base class
#include <prdc/cpu/RField.h>            // member
 
// Forward declarations
namespace Pscf {
   template <int D> class Mesh;
}
 
namespace Pscf {
namespace Rpc { 
 
   using namespace Util;
   using namespace Prdc;
   using namespace Prdc::Cpu;

   template <int D>
   class Solvent : public SolventSpecies
   {
 
   public:

      Solvent();
   
      ~Solvent();
  
      void associate(Mesh<D> const & mesh);

      void allocate();

      void compute(RField<D> const & wField, double phiTot = 1.0);

      RField<D> const & cField() const;
 
      // Inherited accessor functions 
      using Pscf::Species::phi;
      using Pscf::Species::mu;
      using Pscf::Species::q;
      using Pscf::Species::ensemble;
      using Pscf::SolventSpecies::monomerId;
      using Pscf::SolventSpecies::size;
 
   protected:
 
      // Inherited protected functions
      using Pscf::Species::setQ;
      
   private:

      RField<D> cField_;
 
      Mesh<D> const *  meshPtr_;
 
   };
   
   // Inline member function
 
   /*
   * Get monomer concentration field for this solvent.
   */
   template <int D>
   inline RField<D> const & Solvent<D>::cField() const
   {  return cField_;  }
  
   #ifndef RPC_SOLVENT_TPP
   // Supress implicit instantiation
   extern template class Solvent<1>;
   extern template class Solvent<2>;
   extern template class Solvent<3>;
   #endif
 
}
}
#endif