src/primitives/Torsion.hpp

/*
 * 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).
 */
 
/**
 * @file Torsion.hpp
 * @author    tlin
 * @date  11/01/2004
 * @version 1.0
 */

#ifndef PRIMITIVES_TORSION_HPP
#define PRIMITIVES_TORSION_HPP

#include "primitives/ShortRangeInteraction.hpp"
#include "primitives/Atom.hpp"
#include "types/TorsionType.hpp"
#include <limits>

namespace OpenMD {
struct TorsionData {
    RealType angle;
    RealType potential;
};

struct TorsionDataSet {
    RealType deltaV;
    TorsionData prev;
    TorsionData curr;
};


  /**
   * @class Torsion Torsion.hpp "types/Torsion.hpp"
   */
  class Torsion : public ShortRangeInteraction {
  public:
    Torsion(Atom* atom1, Atom* atom2, Atom* atom3, Atom* atom4, TorsionType* tt);
    virtual ~Torsion() {}
    virtual void calcForce(RealType& angle, bool doParticlePot);
                
    RealType getValue(int snapshotNo) {
      Vector3d pos1 = atoms_[0]->getPos(snapshotNo);
      Vector3d pos2 = atoms_[1]->getPos(snapshotNo);
      Vector3d pos3 = atoms_[2]->getPos(snapshotNo);
      Vector3d pos4 = atoms_[3]->getPos(snapshotNo);
      
      Vector3d r21 = pos1 - pos2;
      Vector3d r32 = pos2 - pos3;
      Vector3d r43 = pos3 - pos4;
      
      //  Calculate the cross products and distances
      Vector3d A = cross(r21, r32);
      RealType rA = A.length();
      Vector3d B = cross(r32, r43);
      RealType rB = B.length();
      
      /* 
         If either of the two cross product vectors is tiny, that means
         the three atoms involved are colinear, and the torsion angle is
         going to be undefined.  The easiest check for this problem is
         to use the product of the two lengths.
      */
      if (rA * rB < OpenMD::epsilon) return numeric_limits<double>::quiet_NaN();
      
      A.normalize();
      B.normalize();  
      
      //  Calculate the sin and cos
      RealType cos_phi = dot(A, B) ;
      if (cos_phi > 1.0) cos_phi = 1.0;
      if (cos_phi < -1.0) cos_phi = -1.0;            
      return acos(cos_phi);
    }
    

    RealType getPotential() {
      return potential_;
    }

    Atom* getAtomA() {
      return atoms_[0];
    }

    Atom* getAtomB() {
      return atoms_[1];
    }

    Atom* getAtomC() {
      return atoms_[2];
    }

    Atom* getAtomD() {
      return atoms_[3];
    }

    TorsionType * getTorsionType() {
      return torsionType_;
    }
        
    virtual std::string getName() { return name_;}        
    /** Sets the name of this torsion for selections */
    virtual void setName(const std::string& name) { name_ = name;}

    void accept(BaseVisitor* v) {
      v->visit(this);
    }    

  protected:

    TorsionType* torsionType_;
    std::string name_;        

    RealType potential_;
  };    

}
#endif //PRIMITIVES_TORSION_HPP
Revision:	1953
Committed:	Thu Dec 5 18:19:26 2013 UTC (11 years, 5 months ago) by gezelter
File size:	4905 byte(s)
Log Message:	Rewrote much of selection module, added a bond correlation function
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	246	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	246	* 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	gezelter	1390	*
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	1879	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
39	gezelter	1782	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	246	*/
42
43			/**
44			* @file Torsion.hpp
45			* @author tlin
46			* @date 11/01/2004
47			* @version 1.0
48			*/
49
50			#ifndef PRIMITIVES_TORSION_HPP
51			#define PRIMITIVES_TORSION_HPP
52
53	gezelter	1953	#include "primitives/ShortRangeInteraction.hpp"
54	gezelter	246	#include "primitives/Atom.hpp"
55			#include "types/TorsionType.hpp"
56	gezelter	1953	#include <limits>
57	gezelter	246
58	gezelter	1390	namespace OpenMD {
59	tim	749	struct TorsionData {
60	tim	963	RealType angle;
61			RealType potential;
62	tim	749	};
63	gezelter	246
64	tim	749	struct TorsionDataSet {
65	tim	963	RealType deltaV;
66	tim	749	TorsionData prev;
67			TorsionData curr;
68			};
69
70
71	gezelter	507	/**
72			* @class Torsion Torsion.hpp "types/Torsion.hpp"
73			*/
74	gezelter	1953	class Torsion : public ShortRangeInteraction {
75	gezelter	507	public:
76			Torsion(Atom* atom1, Atom* atom2, Atom* atom3, Atom* atom4, TorsionType* tt);
77			virtual ~Torsion() {}
78	gezelter	1782	virtual void calcForce(RealType& angle, bool doParticlePot);
79	gezelter	1953
80			RealType getValue(int snapshotNo) {
81			Vector3d pos1 = atoms_[0]->getPos(snapshotNo);
82			Vector3d pos2 = atoms_[1]->getPos(snapshotNo);
83			Vector3d pos3 = atoms_[2]->getPos(snapshotNo);
84			Vector3d pos4 = atoms_[3]->getPos(snapshotNo);
85
86			Vector3d r21 = pos1 - pos2;
87			Vector3d r32 = pos2 - pos3;
88			Vector3d r43 = pos3 - pos4;
89
90			// Calculate the cross products and distances
91			Vector3d A = cross(r21, r32);
92			RealType rA = A.length();
93			Vector3d B = cross(r32, r43);
94			RealType rB = B.length();
95
96			/*
97			If either of the two cross product vectors is tiny, that means
98			the three atoms involved are colinear, and the torsion angle is
99			going to be undefined. The easiest check for this problem is
100			to use the product of the two lengths.
101			*/
102			if (rA * rB < OpenMD::epsilon) return numeric_limits<double>::quiet_NaN();
103
104			A.normalize();
105			B.normalize();
106
107			// Calculate the sin and cos
108			RealType cos_phi = dot(A, B) ;
109			if (cos_phi > 1.0) cos_phi = 1.0;
110			if (cos_phi < -1.0) cos_phi = -1.0;
111			return acos(cos_phi);
112			}
113
114
115	tim	963	RealType getPotential() {
116	gezelter	507	return potential_;
117			}
118	gezelter	246
119	gezelter	507	Atom* getAtomA() {
120	gezelter	1953	return atoms_[0];
121	gezelter	507	}
122	gezelter	246
123	gezelter	507	Atom* getAtomB() {
124	gezelter	1953	return atoms_[1];
125	gezelter	507	}
126	gezelter	246
127	gezelter	507	Atom* getAtomC() {
128	gezelter	1953	return atoms_[2];
129	gezelter	507	}
130	gezelter	246
131	gezelter	507	Atom* getAtomD() {
132	gezelter	1953	return atoms_[3];
133	gezelter	507	}
134	gezelter	246
135	gezelter	507	TorsionType * getTorsionType() {
136			return torsionType_;
137			}
138	gezelter	246
139	gezelter	1953	virtual std::string getName() { return name_;}
140			/** Sets the name of this torsion for selections */
141			virtual void setName(const std::string& name) { name_ = name;}
142
143			void accept(BaseVisitor* v) {
144			v->visit(this);
145			}
146
147	gezelter	507	protected:
148	gezelter	246
149	gezelter	507	TorsionType* torsionType_;
150	gezelter	1953	std::string name_;
151	gezelter	246
152	tim	963	RealType potential_;
153	gezelter	507	};
154	gezelter	246
155			}
156			#endif //PRIMITIVES_TORSION_HPP