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, 24107 (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/Atom.hpp"

#include "types/TorsionType.hpp"

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:
    Torsion(Atom* atom1, Atom* atom2, Atom* atom3, Atom* atom4, TorsionType* tt);
    virtual ~Torsion() {}
    virtual void calcForce(RealType& angle);
        
    RealType getPotential() {
      return potential_;
    }

    Atom* getAtomA() {
      return atom1_;
    }

    Atom* getAtomB() {
      return atom2_;
    }

    Atom* getAtomC() {
      return atom3_;
    }

    Atom* getAtomD() {
      return atom4_;
    }

    TorsionType * getTorsionType() {
      return torsionType_;
    }
        
  protected:

    Atom* atom1_;
    Atom* atom2_;
    Atom* atom3_;
    Atom* atom4_;

    TorsionType* torsionType_;

    RealType potential_;
  };    

}
#endif //PRIMITIVES_TORSION_HPP
Revision:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	3367 byte(s)
Log Message:	updated copyright notices
#	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			* [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	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			#include "primitives/Atom.hpp"
54
55			#include "types/TorsionType.hpp"
56
57	gezelter	1390	namespace OpenMD {
58	tim	749	struct TorsionData {
59	tim	963	RealType angle;
60			RealType potential;
61	tim	749	};
62	gezelter	246
63	tim	749	struct TorsionDataSet {
64	tim	963	RealType deltaV;
65	tim	749	TorsionData prev;
66			TorsionData curr;
67			};
68
69
70	gezelter	507	/**
71			* @class Torsion Torsion.hpp "types/Torsion.hpp"
72			*/
73			class Torsion {
74			public:
75			Torsion(Atom* atom1, Atom* atom2, Atom* atom3, Atom* atom4, TorsionType* tt);
76			virtual ~Torsion() {}
77	tim	963	virtual void calcForce(RealType& angle);
78	gezelter	246
79	tim	963	RealType getPotential() {
80	gezelter	507	return potential_;
81			}
82	gezelter	246
83	gezelter	507	Atom* getAtomA() {
84			return atom1_;
85			}
86	gezelter	246
87	gezelter	507	Atom* getAtomB() {
88			return atom2_;
89			}
90	gezelter	246
91	gezelter	507	Atom* getAtomC() {
92			return atom3_;
93			}
94	gezelter	246
95	gezelter	507	Atom* getAtomD() {
96			return atom4_;
97			}
98	gezelter	246
99	gezelter	507	TorsionType * getTorsionType() {
100			return torsionType_;
101			}
102	gezelter	246
103	gezelter	507	protected:
104	gezelter	246
105	gezelter	507	Atom* atom1_;
106			Atom* atom2_;
107			Atom* atom3_;
108			Atom* atom4_;
109	gezelter	246
110	gezelter	507	TorsionType* torsionType_;
111	gezelter	246
112	tim	963	RealType potential_;
113	gezelter	507	};
114	gezelter	246
115			}
116			#endif //PRIMITIVES_TORSION_HPP