src/nonbonded/Morse.cpp

/*
 * Copyright (c) 2005 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, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */

#include <stdio.h>
#include <string.h>

#include <cmath>
#include "nonbonded/Morse.hpp"
#include "utils/simError.h"
#include "types/MorseInteractionType.hpp"

using namespace std;

namespace OpenMD {

  Morse::Morse() : name_("Morse"), initialized_(false), forceField_(NULL) {}
  
  void Morse::initialize() {    

    ForceField::NonBondedInteractionTypeContainer* nbiTypes = forceField_->getNonBondedInteractionTypes();
    ForceField::NonBondedInteractionTypeContainer::MapTypeIterator j;
    NonBondedInteractionType* nbt;
    ForceField::NonBondedInteractionTypeContainer::KeyType keys;

    for (nbt = nbiTypes->beginType(j); nbt != NULL; 
         nbt = nbiTypes->nextType(j)) {
      
      if (nbt->isMorse()) {
        keys = nbiTypes->getKeys(j);
        AtomType* at1 = forceField_->getAtomType(keys[0]);
        AtomType* at2 = forceField_->getAtomType(keys[1]);

        MorseInteractionType* mit = dynamic_cast<MorseInteractionType*>(nbt);

        if (mit == NULL) {
          sprintf( painCave.errMsg,
                   "Morse::initialize could not convert NonBondedInteractionType\n"
                   "\tto MorseInteractionType for %s - %s interaction.\n", 
                   at1->getName().c_str(),
                   at2->getName().c_str());
          painCave.severity = OPENMD_ERROR;
          painCave.isFatal = 1;
          simError();          
        }
        
        RealType De = mit->getD();
        RealType Re = mit->getR();
        RealType beta = mit->getBeta();
   
        MorseType variant = mit->getInteractionType();
        addExplicitInteraction(at1, at2, De, Re, beta, variant );
      }
    }  
    initialized_ = true;
  }
      
  void Morse::addExplicitInteraction(AtomType* atype1, AtomType* atype2, 
                                     RealType De, RealType Re, RealType beta, 
                                     MorseType mt) {

    MorseInteractionData mixer;
    mixer.De = De;
    mixer.Re = Re;
    mixer.beta = beta;
    mixer.variant = mt;

    pair<AtomType*, AtomType*> key1, key2;
    key1 = make_pair(atype1, atype2);
    key2 = make_pair(atype2, atype1);
    
    MixingMap[key1] = mixer;
    if (key2 != key1) {
      MixingMap[key2] = mixer;
    }    
  }
  
  void Morse::calcForce(InteractionData &idat) {

    if (!initialized_) initialize();
    
    map<pair<AtomType*, AtomType*>, MorseInteractionData>::iterator it;
    it = MixingMap.find( idat.atypes );
    if (it != MixingMap.end()) {
      MorseInteractionData mixer = (*it).second;
      
      RealType myPot = 0.0;
      RealType myPotC = 0.0;
      RealType myDeriv = 0.0;
      RealType myDerivC = 0.0;
      
      RealType De = mixer.De;
      RealType Re = mixer.Re;
      RealType beta = mixer.beta;
      MorseType variant = mixer.variant;
      
      // V(r) = D_e exp(-a(r-re)(exp(-a(r-re))-2)
      
      RealType expt     = -beta*( *(idat.rij) - Re);
      RealType expfnc   = exp(expt);
      RealType expfnc2  = expfnc*expfnc;
      
      RealType exptC = 0.0;
      RealType expfncC = 0.0;
      RealType expfnc2C = 0.0;
      
      if (idat.shiftedPot || idat.shiftedForce) {
        exptC     = -beta*( *(idat.rcut) - Re);
        expfncC   = exp(exptC);
        expfnc2C  = expfncC*expfncC;
      }
      
      
      switch(variant) {
      case mtShifted : {
        
        myPot  = De * (expfnc2  - 2.0 * expfnc);
        myDeriv   = 2.0 * De * beta * (expfnc - expfnc2);
        
        if (idat.shiftedPot) {
          myPotC = De * (expfnc2C - 2.0 * expfncC);
          myDerivC = 0.0;
        } else if (idat.shiftedForce) {
          myPotC = De * (expfnc2C - 2.0 * expfncC);
          myDerivC  = 2.0 * De * beta * (expfncC - expfnc2C);
          myPotC += myDerivC * ( *(idat.rij) - *(idat.rcut) );
        } else {
          myPotC = 0.0;
          myDerivC = 0.0;
        }
        
        break;
      }
      case mtRepulsive : {
        
        myPot  = De * expfnc2;
        myDeriv  = -2.0 * De * beta * expfnc2;
        
        if (idat.shiftedPot) {
          myPotC = De * expfnc2C;
          myDerivC = 0.0;
        } else if (idat.shiftedForce) {
          myPotC = De * expfnc2C;
          myDerivC = -2.0 * De * beta * expfnc2C;
          myPotC += myDerivC * ( *(idat.rij) - *(idat.rcut));
        } else {
          myPotC = 0.0;
          myDerivC = 0.0;
        }
        
        break;
      }
      case mtUnknown: {
        // don't know what to do so don't do anything
        break;
      }
      }
      
      RealType pot_temp = *(idat.vdwMult) * (myPot - myPotC);
      *(idat.vpair) += pot_temp;
      
      RealType dudr = *(idat.sw) * *(idat.vdwMult) * (myDeriv - myDerivC);
      
      (*(idat.pot))[VANDERWAALS_FAMILY] += *(idat.sw) * pot_temp;
      *(idat.f1) = *(idat.d) * dudr / *(idat.rij);
    }
    return;
    
  }
    
  RealType Morse::getSuggestedCutoffRadius(pair<AtomType*, AtomType*> atypes) {
    if (!initialized_) initialize();   
    map<pair<AtomType*, AtomType*>, MorseInteractionData>::iterator it;
    it = MixingMap.find(atypes);
    if (it == MixingMap.end()) 
      return 0.0;
    else  {
      MorseInteractionData mixer = (*it).second;

      RealType Re = mixer.Re;
      RealType beta = mixer.beta;
      // This value of the r corresponds to an energy about 1.48% of 
      // the energy at the bottom of the Morse well.  For comparison, the
      // Lennard-Jones function is about 1.63% of it's minimum value at
      // a distance of 2.5 sigma.
      return (4.9 + beta * Re) / beta;
    }
  }
}

Revision:	1874
Committed:	Wed May 15 15:09:35 2013 UTC (12 years ago) by gezelter
File size:	7723 byte(s)
Log Message:	Fixed a bunch of cppcheck warnings.
#	User	Rev	Content
1	gezelter	1501	/*
2			* Copyright (c) 2005 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	gezelter	1850	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (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	1501	*/
42
43			#include <stdio.h>
44			#include <string.h>
45
46			#include <cmath>
47			#include "nonbonded/Morse.hpp"
48			#include "utils/simError.h"
49	gezelter	1664	#include "types/MorseInteractionType.hpp"
50	gezelter	1501
51			using namespace std;
52
53			namespace OpenMD {
54
55	gezelter	1583	Morse::Morse() : name_("Morse"), initialized_(false), forceField_(NULL) {}
56	gezelter	1501
57			void Morse::initialize() {
58
59			ForceField::NonBondedInteractionTypeContainer* nbiTypes = forceField_->getNonBondedInteractionTypes();
60			ForceField::NonBondedInteractionTypeContainer::MapTypeIterator j;
61			NonBondedInteractionType* nbt;
62	gezelter	1664	ForceField::NonBondedInteractionTypeContainer::KeyType keys;
63	gezelter	1501
64			for (nbt = nbiTypes->beginType(j); nbt != NULL;
65			nbt = nbiTypes->nextType(j)) {
66
67			if (nbt->isMorse()) {
68	gezelter	1664	keys = nbiTypes->getKeys(j);
69			AtomType* at1 = forceField_->getAtomType(keys[0]);
70			AtomType* at2 = forceField_->getAtomType(keys[1]);
71	gezelter	1501
72	gezelter	1664	MorseInteractionType* mit = dynamic_cast<MorseInteractionType*>(nbt);
73	gezelter	1501
74	gezelter	1664	if (mit == NULL) {
75	gezelter	1501	sprintf( painCave.errMsg,
76	gezelter	1664	"Morse::initialize could not convert NonBondedInteractionType\n"
77			"\tto MorseInteractionType for %s - %s interaction.\n",
78			at1->getName().c_str(),
79			at2->getName().c_str());
80	gezelter	1501	painCave.severity = OPENMD_ERROR;
81			painCave.isFatal = 1;
82			simError();
83			}
84	gezelter	1664
85			RealType De = mit->getD();
86			RealType Re = mit->getR();
87			RealType beta = mit->getBeta();
88
89			MorseType variant = mit->getInteractionType();
90			addExplicitInteraction(at1, at2, De, Re, beta, variant );
91	gezelter	1501	}
92			}
93			initialized_ = true;
94			}
95
96			void Morse::addExplicitInteraction(AtomType* atype1, AtomType* atype2,
97			RealType De, RealType Re, RealType beta,
98	gezelter	1664	MorseType mt) {
99	gezelter	1501
100			MorseInteractionData mixer;
101			mixer.De = De;
102			mixer.Re = Re;
103			mixer.beta = beta;
104	gezelter	1664	mixer.variant = mt;
105	gezelter	1501
106			pair<AtomType, AtomType> key1, key2;
107			key1 = make_pair(atype1, atype2);
108			key2 = make_pair(atype2, atype1);
109
110			MixingMap[key1] = mixer;
111			if (key2 != key1) {
112			MixingMap[key2] = mixer;
113			}
114			}
115
116	gezelter	1536	void Morse::calcForce(InteractionData &idat) {
117	gezelter	1501
118			if (!initialized_) initialize();
119
120	gezelter	1505	map<pair<AtomType, AtomType>, MorseInteractionData>::iterator it;
121	gezelter	1571	it = MixingMap.find( idat.atypes );
122	gezelter	1505	if (it != MixingMap.end()) {
123			MorseInteractionData mixer = (*it).second;
124
125			RealType myPot = 0.0;
126			RealType myPotC = 0.0;
127			RealType myDeriv = 0.0;
128			RealType myDerivC = 0.0;
129
130			RealType De = mixer.De;
131			RealType Re = mixer.Re;
132			RealType beta = mixer.beta;
133	gezelter	1664	MorseType variant = mixer.variant;
134	gezelter	1505
135			// V(r) = D_e exp(-a(r-re)(exp(-a(r-re))-2)
136
137	gezelter	1554	RealType expt = -beta( (idat.rij) - Re);
138	gezelter	1505	RealType expfnc = exp(expt);
139			RealType expfnc2 = expfnc*expfnc;
140
141			RealType exptC = 0.0;
142			RealType expfncC = 0.0;
143			RealType expfnc2C = 0.0;
144
145	gezelter	1583	if (idat.shiftedPot \|\| idat.shiftedForce) {
146	gezelter	1554	exptC = -beta( (idat.rcut) - Re);
147	gezelter	1505	expfncC = exp(exptC);
148			expfnc2C = expfncC*expfncC;
149	gezelter	1501	}
150	gezelter	1505
151
152	gezelter	1664	switch(variant) {
153			case mtShifted : {
154	gezelter	1505
155			myPot = De * (expfnc2 - 2.0 * expfnc);
156			myDeriv = 2.0 * De * beta * (expfnc - expfnc2);
157
158	gezelter	1583	if (idat.shiftedPot) {
159	gezelter	1505	myPotC = De * (expfnc2C - 2.0 * expfncC);
160			myDerivC = 0.0;
161	gezelter	1583	} else if (idat.shiftedForce) {
162	gezelter	1505	myPotC = De * (expfnc2C - 2.0 * expfncC);
163	gezelter	1874	myDerivC = 2.0 * De * beta * (expfncC - expfnc2C);
164	gezelter	1554	myPotC += myDerivC * ( (idat.rij) - (idat.rcut) );
165	gezelter	1505	} else {
166			myPotC = 0.0;
167			myDerivC = 0.0;
168			}
169
170			break;
171	gezelter	1501	}
172	gezelter	1664	case mtRepulsive : {
173	gezelter	1505
174			myPot = De * expfnc2;
175			myDeriv = -2.0 * De * beta * expfnc2;
176
177	gezelter	1583	if (idat.shiftedPot) {
178	gezelter	1505	myPotC = De * expfnc2C;
179			myDerivC = 0.0;
180	gezelter	1583	} else if (idat.shiftedForce) {
181	gezelter	1505	myPotC = De * expfnc2C;
182			myDerivC = -2.0 * De * beta * expfnc2C;
183	gezelter	1554	myPotC += myDerivC * ( (idat.rij) - (idat.rcut));
184	gezelter	1505	} else {
185			myPotC = 0.0;
186			myDerivC = 0.0;
187			}
188
189			break;
190			}
191	gezelter	1664	case mtUnknown: {
192			// don't know what to do so don't do anything
193			break;
194	gezelter	1505	}
195	gezelter	1664	}
196	gezelter	1505
197	gezelter	1554	RealType pot_temp = (idat.vdwMult) (myPot - myPotC);
198			*(idat.vpair) += pot_temp;
199	gezelter	1505
200	gezelter	1554	RealType dudr = (idat.sw) (idat.vdwMult) (myDeriv - myDerivC);
201	gezelter	1505
202	gezelter	1582	((idat.pot))[VANDERWAALS_FAMILY] += (idat.sw) * pot_temp;
203	gezelter	1554	(idat.f1) = (idat.d) * dudr / *(idat.rij);
204	gezelter	1501	}
205	gezelter	1505	return;
206	gezelter	1501
207	gezelter	1505	}
208
209	gezelter	1545	RealType Morse::getSuggestedCutoffRadius(pair<AtomType, AtomType> atypes) {
210	gezelter	1505	if (!initialized_) initialize();
211			map<pair<AtomType, AtomType>, MorseInteractionData>::iterator it;
212	gezelter	1545	it = MixingMap.find(atypes);
213	gezelter	1505	if (it == MixingMap.end())
214			return 0.0;
215			else {
216			MorseInteractionData mixer = (*it).second;
217	gezelter	1501
218	gezelter	1505	RealType Re = mixer.Re;
219			RealType beta = mixer.beta;
220			// This value of the r corresponds to an energy about 1.48% of
221			// the energy at the bottom of the Morse well. For comparison, the
222			// Lennard-Jones function is about 1.63% of it's minimum value at
223			// a distance of 2.5 sigma.
224			return (4.9 + beta * Re) / beta;
225			}
226	gezelter	1501	}
227			}
228