src/nonbonded/SC.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_SC_HPP
#define NONBONDED_SC_HPP

#include "types/AtomType.hpp"
#include "UseTheForce/ForceField.hpp"
#include "math/Vector3.hpp"
#include "math/CubicSpline.hpp"

namespace OpenMD {

  struct SCAtomData {
    RealType c;
    RealType m;
    RealType n;
    RealType alpha;
    RealType epsilon;
    RealType rCut;
  };
  
  struct SCInteractionData {
    RealType alpha;
    RealType epsilon;
    RealType m;
    RealType n;
    RealType rCut;
    RealType vCut;
    CubicSpline* V;
    CubicSpline* phi;
    bool explicitlySet;
  };
    
  class SC {
    
  public:    
    static SC* Instance();
    static void setForceField(ForceField *ff) {forceField_ = ff;};
    static void initialize();
    static void addType(AtomType* atomType);
    static void addExplicitInteraction(AtomType* atype1, AtomType* atype2, RealType epsilon, RealType m, RealType n, RealType alpha);
    
    static void calcDensity(AtomType* at1, AtomType* at2, const RealType rij, RealType &rho_i_at_j, RealType &rho_j_at_i);

    static void calcFunctional(AtomType* at1, const RealType rho, RealType &frho, RealType &dfrhodrho);

    static void calcForce(AtomType* at1, AtomType* at2, const Vector3d d, const RealType rij, const RealType r2, const RealType sw, RealType &vpair, RealType &pot, Vector3d &f1, const RealType rho1, const RealType rho2, const RealType dfrho1, const RealType dfrho2, RealType &fshift1, RealType &fshift2);
                          
    // Fortran support routines; 
    static void calc_sc_prepair_rho(int *atid1, int *atid2, RealType *rij,  RealType* rho_i_at_j, RealType* rho_j_at_i);
    static void calc_sc_preforce_Frho(int *atid1, RealType* rho, RealType* frho, RealType* dfrhodrho);
    static void do_sc_pair(int *atid1, int *atid2, RealType *d, RealType *rij, RealType *r2,  RealType *sw, RealType *vpair, RealType *pot, RealType *f1, RealType* rho1, RealType* rho2, RealType* dfrho1, RealType* dfrho2, RealType* fshift1, RealType* fshift2);
    static void setCutoffSC(RealType *thisRcut);
    static RealType getSCcut(int *atid1);

  private:
    virtual ~SC() { }
    // singleton pattern, prevent reconstruction
    SC() { }
    SC(SC const &) {};
    SC& operator=(SC const&) {};
    static SC* _instance;
    
    static SCParam getSCParam(AtomType* atomType);
    static RealType getC(AtomType* atomType);
    static RealType getM(AtomType* atomType);
    static RealType getN(AtomType* atomType);
    static RealType getAlpha(AtomType* atomType);
    static RealType getEpsilon(AtomType* atomType);
    static RealType getAlpha(AtomType* atomType1, AtomType* atomType2);
    static RealType getEpsilon(AtomType* atomType1, AtomType* atomType2);
    static RealType getM(AtomType* atomType1, AtomType* atomType2);
    static RealType getN(AtomType* atomType1, AtomType* atomType2);
    
    static bool initialized_;
    static map<int, AtomType*> SClist;
    static map<AtomType*, SCAtomData> SCMap;
    static map<pair<AtomType*, AtomType*>, SCInteractionData> MixingMap;
    static ForceField* forceField_;
    static RealType scRcut_;
    static int np_;
    
  };
}

                               
#endif
Revision:	1489
Committed:	Tue Aug 10 18:34:59 2010 UTC (14 years, 9 months ago) by gezelter
File size:	5270 byte(s)
Log Message:	Migrating Sutton-Chen from Fortran over to C++
#	User	Rev	Content
1	gezelter	1489	/*
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_SC_HPP
43			#define NONBONDED_SC_HPP
44
45			#include "types/AtomType.hpp"
46			#include "UseTheForce/ForceField.hpp"
47			#include "math/Vector3.hpp"
48			#include "math/CubicSpline.hpp"
49
50			namespace OpenMD {
51
52			struct SCAtomData {
53			RealType c;
54			RealType m;
55			RealType n;
56			RealType alpha;
57			RealType epsilon;
58			RealType rCut;
59			};
60
61			struct SCInteractionData {
62			RealType alpha;
63			RealType epsilon;
64			RealType m;
65			RealType n;
66			RealType rCut;
67			RealType vCut;
68			CubicSpline* V;
69			CubicSpline* phi;
70			bool explicitlySet;
71			};
72
73			class SC {
74
75			public:
76			static SC* Instance();
77			static void setForceField(ForceField *ff) {forceField_ = ff;};
78			static void initialize();
79			static void addType(AtomType* atomType);
80			static void addExplicitInteraction(AtomType* atype1, AtomType* atype2, RealType epsilon, RealType m, RealType n, RealType alpha);
81
82			static void calcDensity(AtomType* at1, AtomType* at2, const RealType rij, RealType &rho_i_at_j, RealType &rho_j_at_i);
83
84			static void calcFunctional(AtomType* at1, const RealType rho, RealType &frho, RealType &dfrhodrho);
85
86			static void calcForce(AtomType* at1, AtomType* at2, const Vector3d d, const RealType rij, const RealType r2, const RealType sw, RealType &vpair, RealType &pot, Vector3d &f1, const RealType rho1, const RealType rho2, const RealType dfrho1, const RealType dfrho2, RealType &fshift1, RealType &fshift2);
87
88			// Fortran support routines;
89			static void calc_sc_prepair_rho(int atid1, int atid2, RealType rij, RealType rho_i_at_j, RealType* rho_j_at_i);
90			static void calc_sc_preforce_Frho(int atid1, RealType rho, RealType* frho, RealType* dfrhodrho);
91			static void do_sc_pair(int atid1, int atid2, RealType d, RealType rij, RealType r2, RealType sw, RealType vpair, RealType pot, RealType f1, RealType rho1, RealType* rho2, RealType* dfrho1, RealType* dfrho2, RealType* fshift1, RealType* fshift2);
92			static void setCutoffSC(RealType *thisRcut);
93			static RealType getSCcut(int *atid1);
94
95			private:
96			virtual ~SC() { }
97			// singleton pattern, prevent reconstruction
98			SC() { }
99			SC(SC const &) {};
100			SC& operator=(SC const&) {};
101			static SC* _instance;
102
103			static SCParam getSCParam(AtomType* atomType);
104			static RealType getC(AtomType* atomType);
105			static RealType getM(AtomType* atomType);
106			static RealType getN(AtomType* atomType);
107			static RealType getAlpha(AtomType* atomType);
108			static RealType getEpsilon(AtomType* atomType);
109			static RealType getAlpha(AtomType* atomType1, AtomType* atomType2);
110			static RealType getEpsilon(AtomType* atomType1, AtomType* atomType2);
111			static RealType getM(AtomType* atomType1, AtomType* atomType2);
112			static RealType getN(AtomType* atomType1, AtomType* atomType2);
113
114			static bool initialized_;
115			static map<int, AtomType*> SClist;
116			static map<AtomType*, SCAtomData> SCMap;
117			static map<pair<AtomType, AtomType>, SCInteractionData> MixingMap;
118			static ForceField* forceField_;
119			static RealType scRcut_;
120			static int np_;
121
122			};
123			}
124
125
126			#endif