cpc/solvers/Solvent.h

#ifndef CPC_SOLVENT_H
#define CPC_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/CField.h>            // member
#include <complex>
 
// Forward declaration
namespace Pscf {
   template <int D> class Mesh;
}
 
namespace Pscf {
namespace Cpc {
 
   using namespace Util;
   using namespace Prdc;
   using namespace Prdc::Cpu;

   template <int D>
   class Solvent 
    : public SolventSpecies< std::complex<double> >
   {
 
   public:
 
      // Typename aliases

      using Base = SolventSpecies< std::complex<double> >;

      using SpeciesT = SolventSpecies< std::complex<double> >;
 
      // Member functions

      Solvent();

      ~Solvent();

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

      void allocate();

      void compute(CField<D> const & wField);

      CField<D> const & cField() const;
 
      // Inherited accessor functions
      using SpeciesT::phi;
      using SpeciesT::mu;
      using SpeciesT::q;
      using SpeciesT::ensemble;
      using Base::monomerId;
      using Base::size;
 
   protected:
 
      // Inherited protected functions
      using SpeciesT::setQ;
 
   private:

      CField<D> cField_;

      Mesh<D> const *  meshPtr_;
 
   };
 
   // Inline member function
 
   /*
   * Get complex monomer concentration field for this solvent.
   */
   template <int D>
   inline CField<D> const & Solvent<D>::cField() const
   {  return cField_;  }
 
   // Explicit instantiation declarations
   extern template class Solvent<1>;
   extern template class Solvent<2>;
   extern template class Solvent<3>;
 
} // namespace Cpc
} // namespace Pscf
#endif