| 1 |
/* |
| 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 |
* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008). |
| 39 |
* [4] Vardeman & Gezelter, in progress (2009). |
| 40 |
*/ |
| 41 |
|
| 42 |
/** |
| 43 |
* @file Vector3.hpp |
| 44 |
* @author Teng Lin |
| 45 |
* @date 09/14/2004 |
| 46 |
* @version 1.0 |
| 47 |
*/ |
| 48 |
|
| 49 |
#ifndef MATH_VECTOR3_HPP |
| 50 |
#define MATH_VECTOR3_HPP |
| 51 |
|
| 52 |
#include <cassert> |
| 53 |
#include <cmath> |
| 54 |
|
| 55 |
#include "Vector.hpp" |
| 56 |
|
| 57 |
namespace OpenMD { |
| 58 |
|
| 59 |
/** |
| 60 |
* @class Vector3 Vector3.hpp "math/Vector3.hpp" |
| 61 |
* @brief |
| 62 |
*/ |
| 63 |
|
| 64 |
template<typename Real> |
| 65 |
class Vector3 : public Vector<Real, 3>{ |
| 66 |
public: |
| 67 |
typedef Real ElemType; |
| 68 |
typedef Real* ElemPoinerType; |
| 69 |
Vector3() : Vector<Real, 3>(){} |
| 70 |
|
| 71 |
/** Constructs and initializes a Vector3 from x, y, z coordinates */ |
| 72 |
inline Vector3( Real x, Real y, Real z) { |
| 73 |
this->data_[0] = x; |
| 74 |
this->data_[1] = y; |
| 75 |
this->data_[2] = z; |
| 76 |
} |
| 77 |
|
| 78 |
/** Constructs and initializes from an array*/ |
| 79 |
inline Vector3(Real* array) : Vector<Real, 3>(array) {} |
| 80 |
|
| 81 |
inline Vector3(const Vector<Real, 3>& v) : Vector<Real, 3>(v) {} |
| 82 |
|
| 83 |
inline Vector3<Real>& operator = (const Vector<Real, 3>& v) { |
| 84 |
if (this == &v) { return *this; } |
| 85 |
Vector<Real, 3>::operator=(v); |
| 86 |
return *this; |
| 87 |
} |
| 88 |
|
| 89 |
/** |
| 90 |
* Retunrs reference of the first element of Vector3. |
| 91 |
* @return reference of the first element of Vector3 |
| 92 |
*/ |
| 93 |
inline Real& x() { return this->data_[0];} |
| 94 |
|
| 95 |
/** |
| 96 |
* Retunrs the first element of Vector3. |
| 97 |
* @return the first element of Vector3 |
| 98 |
*/ |
| 99 |
inline Real x() const { return this->data_[0];} |
| 100 |
|
| 101 |
/** |
| 102 |
* Retunrs reference of the second element of Vector3. |
| 103 |
* @return reference of the second element of Vector3 |
| 104 |
*/ |
| 105 |
inline Real& y() { return this->data_[1];} |
| 106 |
|
| 107 |
/** |
| 108 |
* Retunrs the second element of Vector3. |
| 109 |
* @return c the second element of Vector3 |
| 110 |
*/ |
| 111 |
inline Real y() const { return this->data_[1];} |
| 112 |
|
| 113 |
/** |
| 114 |
* Retunrs reference of the third element of Vector3. |
| 115 |
* @return reference of the third element of Vector3 |
| 116 |
*/ |
| 117 |
inline Real& z() { return this->data_[2];} |
| 118 |
|
| 119 |
/** |
| 120 |
* Retunrs the third element of Vector3. |
| 121 |
* @return f the third element of Vector3 |
| 122 |
*/ |
| 123 |
inline Real z() const { return this->data_[2];} |
| 124 |
|
| 125 |
}; |
| 126 |
|
| 127 |
/** |
| 128 |
* Returns the cross product of two Vectors |
| 129 |
* @param v1 first vector |
| 130 |
* @param v2 second vector |
| 131 |
* @return the cross product of v1 and v2 |
| 132 |
* @see #vector::dot |
| 133 |
*/ |
| 134 |
template<typename Real> |
| 135 |
Vector3<Real> cross( const Vector3<Real>& v1, const Vector3<Real>& v2 ) { |
| 136 |
Vector3<Real> result; |
| 137 |
|
| 138 |
result.x() = v1.y() * v2.z() - v1.z() * v2.y(); |
| 139 |
result.y() = v1.z() * v2.x() - v1.x() * v2.z(); |
| 140 |
result.z() = v1.x() * v2.y() - v1.y() * v2.x(); |
| 141 |
|
| 142 |
return result; |
| 143 |
} |
| 144 |
|
| 145 |
typedef Vector3<int> Vector3i; |
| 146 |
|
| 147 |
typedef Vector3<RealType> Vector3d; |
| 148 |
|
| 149 |
const Vector3d V3Zero(0.0 , 0.0, 0.0); |
| 150 |
const Vector3d V3X( 1.0, 0.0, 0.0 ) ; |
| 151 |
const Vector3d V3Y( 0.0, 1.0, 0.0 ) ; |
| 152 |
const Vector3d V3Z ( 0.0, 0.0, 1.0 ) ; |
| 153 |
|
| 154 |
} |
| 155 |
|
| 156 |
#endif |
