ddMd/potentials/external/ExternalPotential.h

#ifndef DDMD_EXTERNAL_POTENTIAL_H
#define DDMD_EXTERNAL_POTENTIAL_H

#include <ddMd/potentials/Potential.h>  // base class
#include <simp/boundary/Boundary.h>     // member (typedef)
#include <util/global.h>

#include <iostream>

/*
* Simpatico - Simulation Package for Polymeric and Molecular Liquids
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/

namespace DdMd
{

   class Simulation;
   class AtomStorage;

   using namespace Util;
   using namespace Simp;

   class ExternalPotential : public Potential
   {

   public:

      ExternalPotential(Simulation& simulation);

      ExternalPotential();

      virtual void associate(Boundary& boundary, AtomStorage& storage);

      virtual ~ExternalPotential();



      virtual void setNAtomType(int nAtomType) = 0;
  
      virtual double externalEnergy(const Vector& position, int i) const = 0;

      virtual void getExternalForce(const Vector& position, int type, 
                                    Vector& force) const = 0;

      virtual void set(std::string name, double value) = 0;

      virtual double get(std::string name) const = 0;

      virtual std::string interactionClassName() const = 0;
   

   protected:

      Simulation& simulation();

      Boundary& boundary();

      AtomStorage& storage();

   private:

      // Pointer to parent Simulation object.
      Simulation* simulationPtr_;

      // Pointer to associated Boundary object.
      Boundary* boundaryPtr_;

      // Pointer to associated AtomStorage object.
      AtomStorage* storagePtr_;

   };

   inline Simulation& ExternalPotential::simulation() 
   {  return *simulationPtr_; }

   inline Boundary& ExternalPotential::boundary() 
   {  return *boundaryPtr_; }

   inline AtomStorage& ExternalPotential::storage()
   {  return *storagePtr_; }

}
#endif