src/nonbonded/GB.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]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
#ifndef NONBONDED_GB_HPP
#define NONBONDED_GB_HPP

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

using namespace std;
namespace OpenMD {

  struct GBInteractionData {
    RealType sigma0;
    RealType eps0;
    RealType dw;
    RealType x2;
    RealType xa2;
    RealType xai2;
    RealType xp2;
    RealType xpap2;
    RealType xpapi2;
  };

  class GB : public VanDerWaalsInteraction {
    
  public:    
    GB();
    void setForceField(ForceField *ff) {forceField_ = ff;};
    void addType(AtomType* atomType);
    virtual void calcForce(InteractionData &idat);
    virtual string getName() {return name_;}
    virtual RealType getSuggestedCutoffRadius(pair<AtomType*, AtomType*> atypes);
    
  private:
    void initialize();
    GayBerneParam  getGayBerneParam(AtomType* atomType);
    RealType getD(AtomType* atomType);
    RealType getL(AtomType* atomType);
    RealType getEps(AtomType* atomType);
    RealType getEpsRatio(AtomType* atomType);
    RealType getDw(AtomType* atomType);
    LJParam  getLJParam(AtomType* atomType);
    RealType getLJSigma(AtomType* atomType);
    RealType getLJEpsilon(AtomType* atomType);

    bool initialized_;
    string name_;
    map<int, AtomType*> GBMap;
    map<pair<AtomType*, AtomType*>, GBInteractionData> MixingMap;
    ForceField* forceField_;
    RealType mu_;
    RealType nu_;
    
  };
}

                               
#endif
Revision:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 8 months ago) by gezelter
File size:	3684 byte(s)
Log Message:	updated copyright notices
#	User	Rev	Content
1	gezelter	1483	/*
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	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	1483	*/
42
43			#ifndef NONBONDED_GB_HPP
44			#define NONBONDED_GB_HPP
45
46	gezelter	1502	#include "nonbonded/NonBondedInteraction.hpp"
47	gezelter	1483	#include "types/DirectionalAtomType.hpp"
48			#include "UseTheForce/ForceField.hpp"
49			#include "math/SquareMatrix3.hpp"
50
51			using namespace std;
52			namespace OpenMD {
53
54			struct GBInteractionData {
55			RealType sigma0;
56			RealType eps0;
57			RealType dw;
58			RealType x2;
59			RealType xa2;
60			RealType xai2;
61			RealType xp2;
62			RealType xpap2;
63			RealType xpapi2;
64			};
65
66	gezelter	1502	class GB : public VanDerWaalsInteraction {
67	gezelter	1483
68			public:
69	gezelter	1502	GB();
70			void setForceField(ForceField *ff) {forceField_ = ff;};
71			void addType(AtomType* atomType);
72	gezelter	1536	virtual void calcForce(InteractionData &idat);
73	gezelter	1502	virtual string getName() {return name_;}
74	gezelter	1545	virtual RealType getSuggestedCutoffRadius(pair<AtomType, AtomType> atypes);
75	gezelter	1483
76			private:
77	gezelter	1502	void initialize();
78			GayBerneParam getGayBerneParam(AtomType* atomType);
79			RealType getD(AtomType* atomType);
80			RealType getL(AtomType* atomType);
81			RealType getEps(AtomType* atomType);
82			RealType getEpsRatio(AtomType* atomType);
83			RealType getDw(AtomType* atomType);
84			LJParam getLJParam(AtomType* atomType);
85			RealType getLJSigma(AtomType* atomType);
86			RealType getLJEpsilon(AtomType* atomType);
87	gezelter	1483
88	gezelter	1502	bool initialized_;
89			string name_;
90			map<int, AtomType*> GBMap;
91			map<pair<AtomType, AtomType>, GBInteractionData> MixingMap;
92			ForceField* forceField_;
93			RealType mu_;
94			RealType nu_;
95	gezelter	1483
96			};
97			}
98
99
100			#endif