src/nonbonded/Electrostatic.hpp

/*
 * Copyright (c) 2009 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman & Gezelter, in progress (2009).                        
 */
 
#ifndef NONBONDED_ELECTROSTATIC_HPP
#define NONBONDED_ELECTROSTATIC_HPP

#include "nonbonded/NonBondedInteraction.hpp"
#include "types/AtomType.hpp"
#include "UseTheForce/ForceField.hpp"
#include "math/SquareMatrix3.hpp"
#include "math/CubicSpline.hpp"

namespace OpenMD {

  struct ElectrostaticAtomData {
    bool is_Charge;
    bool is_Dipole;
    bool is_SplitDipole;
    bool is_Quadrupole;
    RealType charge;
    RealType dipole_moment;
    RealType split_dipole_distance;
    Vector3d quadrupole_moments;
  };
  
  enum ElectrostaticSummationMethod{
    NONE,
    SWITCHING_FUNCTION,
    SHIFTED_POTENTIAL,
    SHIFTED_FORCE,
    REACTION_FIELD,
    EWALD_FULL,  /**< Ewald methods aren't supported yet */
    EWALD_PME,   /**< Ewald methods aren't supported yet */
    EWALD_SPME   /**< Ewald methods aren't supported yet */
  };

  enum ElectrostaticScreeningMethod{
    UNDAMPED,
    DAMPED
  };
  
  class Electrostatic : public ElectrostaticInteraction {
    
  public:    
    Electrostatic();
    void setForceField(ForceField *ff) {forceField_ = ff;};
    void addType(AtomType* atomType);
    virtual void calcForce(InteractionData idat);
    virtual void calcSkipCorrection(SkipCorrectionData skdat);
    virtual void calcSelfCorrection(SelfCorrectionData scdat);
    virtual string getName() {return name_;}
    virtual RealType getSuggestedCutoffRadius(AtomType* at1, AtomType* at2);

    void setElectrostaticCutoffRadius( RealType theECR, RealType theRSW );
    void setElectrostaticSummationMethod( ElectrostaticSummationMethod esm );
    void setElectrostaticScreeningMethod( ElectrostaticScreeningMethod sm );
    void setDampingAlpha( RealType alpha );
    void setReactionFieldDielectric( RealType dielectric );

  private:
    void initialize();
    string name_;
    bool initialized_;
    bool haveDefaultCutoff_;
    bool haveDampingAlpha_;
    bool haveDielectric_;
    bool haveElectroSpline_;
    std::map<int, AtomType*> ElectrostaticList;
    std::map<AtomType*, ElectrostaticAtomData> ElectrostaticMap;
    ForceField* forceField_;
    RealType defaultCutoff_;
    RealType defaultCutoff2_;
    RealType pre11_;
    RealType pre12_;
    RealType pre22_;
    RealType pre14_;
    RealType chargeToC_;
    RealType angstromToM_;
    RealType debyeToCm_;
    int np_;
    ElectrostaticSummationMethod summationMethod_;    
    ElectrostaticScreeningMethod screeningMethod_;
    RealType dampingAlpha_;
    RealType alpha2_;
    RealType alpha4_;
    RealType alpha6_;
    RealType alpha8_;
    RealType dielectric_;
    RealType constEXP_;
    RealType rcuti_;
    RealType rcuti2_;
    RealType rcuti3_;
    RealType rcuti4_;
    RealType alphaPi_;
    RealType invRootPi_;
    RealType rrf_;
    RealType rt_;
    RealType rrfsq_;
    RealType preRF_;
    RealType preRF2_;
    RealType erfcVal_;
    RealType derfcVal_;
    CubicSpline* erfcSpline_;
    RealType c1_;
    RealType c2_;
    RealType c3_;
    RealType c4_;
    RealType c5_;
    RealType c6_;
    RealType c1c_;
    RealType c2c_;
    RealType c3c_;
    RealType c4c_;
    RealType c5c_;
    RealType c6c_;
    RealType one_third_;    
  };
}

                               
#endif
Revision:	1505
Committed:	Sun Oct 3 22:18:59 2010 UTC (14 years, 9 months ago) by gezelter
File size:	5303 byte(s)
Log Message:	Less busted than it was on last check-in, but still won't completely build.
#	User	Rev	Content
1	gezelter	1502	/*
2			* Copyright (c) 2009 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9			* 1. Redistributions of source code must retain the above copyright
10			* notice, this list of conditions and the following disclaimer.
11			*
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31			*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39			* [4] Vardeman & Gezelter, in progress (2009).
40			*/
41
42			#ifndef NONBONDED_ELECTROSTATIC_HPP
43			#define NONBONDED_ELECTROSTATIC_HPP
44
45			#include "nonbonded/NonBondedInteraction.hpp"
46			#include "types/AtomType.hpp"
47			#include "UseTheForce/ForceField.hpp"
48			#include "math/SquareMatrix3.hpp"
49			#include "math/CubicSpline.hpp"
50
51			namespace OpenMD {
52
53			struct ElectrostaticAtomData {
54			bool is_Charge;
55			bool is_Dipole;
56			bool is_SplitDipole;
57			bool is_Quadrupole;
58			RealType charge;
59			RealType dipole_moment;
60			RealType split_dipole_distance;
61			Vector3d quadrupole_moments;
62			};
63
64			enum ElectrostaticSummationMethod{
65			NONE,
66			SWITCHING_FUNCTION,
67			SHIFTED_POTENTIAL,
68			SHIFTED_FORCE,
69			REACTION_FIELD,
70			EWALD_FULL, /*< Ewald methods aren't supported yet /
71			EWALD_PME, /*< Ewald methods aren't supported yet /
72			EWALD_SPME /*< Ewald methods aren't supported yet /
73			};
74
75			enum ElectrostaticScreeningMethod{
76			UNDAMPED,
77			DAMPED
78			};
79
80			class Electrostatic : public ElectrostaticInteraction {
81
82			public:
83			Electrostatic();
84			void setForceField(ForceField *ff) {forceField_ = ff;};
85			void addType(AtomType* atomType);
86	gezelter	1505	virtual void calcForce(InteractionData idat);
87			virtual void calcSkipCorrection(SkipCorrectionData skdat);
88			virtual void calcSelfCorrection(SelfCorrectionData scdat);
89	gezelter	1502	virtual string getName() {return name_;}
90	gezelter	1505	virtual RealType getSuggestedCutoffRadius(AtomType* at1, AtomType* at2);
91	gezelter	1502
92			void setElectrostaticCutoffRadius( RealType theECR, RealType theRSW );
93			void setElectrostaticSummationMethod( ElectrostaticSummationMethod esm );
94			void setElectrostaticScreeningMethod( ElectrostaticScreeningMethod sm );
95			void setDampingAlpha( RealType alpha );
96			void setReactionFieldDielectric( RealType dielectric );
97
98			private:
99			void initialize();
100			string name_;
101			bool initialized_;
102			bool haveDefaultCutoff_;
103			bool haveDampingAlpha_;
104			bool haveDielectric_;
105			bool haveElectroSpline_;
106			std::map<int, AtomType*> ElectrostaticList;
107			std::map<AtomType*, ElectrostaticAtomData> ElectrostaticMap;
108			ForceField* forceField_;
109			RealType defaultCutoff_;
110			RealType defaultCutoff2_;
111			RealType pre11_;
112			RealType pre12_;
113			RealType pre22_;
114			RealType pre14_;
115			RealType chargeToC_;
116			RealType angstromToM_;
117			RealType debyeToCm_;
118			int np_;
119			ElectrostaticSummationMethod summationMethod_;
120			ElectrostaticScreeningMethod screeningMethod_;
121			RealType dampingAlpha_;
122			RealType alpha2_;
123			RealType alpha4_;
124			RealType alpha6_;
125			RealType alpha8_;
126			RealType dielectric_;
127			RealType constEXP_;
128			RealType rcuti_;
129			RealType rcuti2_;
130			RealType rcuti3_;
131			RealType rcuti4_;
132			RealType alphaPi_;
133			RealType invRootPi_;
134			RealType rrf_;
135			RealType rt_;
136			RealType rrfsq_;
137			RealType preRF_;
138			RealType preRF2_;
139			RealType erfcVal_;
140			RealType derfcVal_;
141			CubicSpline* erfcSpline_;
142			RealType c1_;
143			RealType c2_;
144			RealType c3_;
145			RealType c4_;
146			RealType c5_;
147			RealType c6_;
148			RealType c1c_;
149			RealType c2c_;
150			RealType c3c_;
151			RealType c4c_;
152			RealType c5c_;
153			RealType c6c_;
154			RealType one_third_;
155			};
156			}
157
158
159			#endif