| 1 | gezelter | 507 | /* | 
| 2 | gezelter | 246 | * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. | 
| 3 | tim | 70 | * | 
| 4 | gezelter | 246 | * 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 | tim | 70 | */ | 
| 42 | gezelter | 246 |  | 
| 43 | tim | 70 | /** | 
| 44 |  |  | * @file SquareMatrix.hpp | 
| 45 |  |  | * @author Teng Lin | 
| 46 |  |  | * @date 10/11/2004 | 
| 47 |  |  | * @version 1.0 | 
| 48 |  |  | */ | 
| 49 | gezelter | 507 | #ifndef MATH_SQUAREMATRIX_HPP | 
| 50 | tim | 70 | #define MATH_SQUAREMATRIX_HPP | 
| 51 |  |  |  | 
| 52 | tim | 74 | #include "math/RectMatrix.hpp" | 
| 53 | gezelter | 956 | #include "utils/NumericConstant.hpp" | 
| 54 | tim | 70 |  | 
| 55 | gezelter | 1390 | namespace OpenMD { | 
| 56 | tim | 70 |  | 
| 57 | gezelter | 507 | /** | 
| 58 |  |  | * @class SquareMatrix SquareMatrix.hpp "math/SquareMatrix.hpp" | 
| 59 |  |  | * @brief A square matrix class | 
| 60 |  |  | * @template Real the element type | 
| 61 |  |  | * @template Dim the dimension of the square matrix | 
| 62 |  |  | */ | 
| 63 |  |  | template<typename Real, int Dim> | 
| 64 |  |  | class SquareMatrix : public RectMatrix<Real, Dim, Dim> { | 
| 65 |  |  | public: | 
| 66 |  |  | typedef Real ElemType; | 
| 67 |  |  | typedef Real* ElemPoinerType; | 
| 68 | tim | 70 |  | 
| 69 | gezelter | 507 | /** default constructor */ | 
| 70 |  |  | SquareMatrix() { | 
| 71 |  |  | for (unsigned int i = 0; i < Dim; i++) | 
| 72 |  |  | for (unsigned int j = 0; j < Dim; j++) | 
| 73 |  |  | this->data_[i][j] = 0.0; | 
| 74 |  |  | } | 
| 75 | tim | 70 |  | 
| 76 | gezelter | 507 | /** Constructs and initializes every element of this matrix to a scalar */ | 
| 77 |  |  | SquareMatrix(Real s) : RectMatrix<Real, Dim, Dim>(s){ | 
| 78 |  |  | } | 
| 79 | tim | 151 |  | 
| 80 | gezelter | 507 | /** Constructs and initializes from an array */ | 
| 81 |  |  | SquareMatrix(Real* array) : RectMatrix<Real, Dim, Dim>(array){ | 
| 82 |  |  | } | 
| 83 | tim | 151 |  | 
| 84 |  |  |  | 
| 85 | gezelter | 507 | /** copy constructor */ | 
| 86 |  |  | SquareMatrix(const RectMatrix<Real, Dim, Dim>& m) : RectMatrix<Real, Dim, Dim>(m) { | 
| 87 |  |  | } | 
| 88 | tim | 70 |  | 
| 89 | gezelter | 507 | /** copy assignment operator */ | 
| 90 |  |  | SquareMatrix<Real, Dim>& operator =(const RectMatrix<Real, Dim, Dim>& m) { | 
| 91 |  |  | RectMatrix<Real, Dim, Dim>::operator=(m); | 
| 92 |  |  | return *this; | 
| 93 |  |  | } | 
| 94 | tim | 137 |  | 
| 95 | gezelter | 507 | /** Retunrs  an identity matrix*/ | 
| 96 | tim | 74 |  | 
| 97 | gezelter | 507 | static SquareMatrix<Real, Dim> identity() { | 
| 98 |  |  | SquareMatrix<Real, Dim> m; | 
| 99 | tim | 137 |  | 
| 100 | gezelter | 507 | for (unsigned int i = 0; i < Dim; i++) | 
| 101 |  |  | for (unsigned int j = 0; j < Dim; j++) | 
| 102 |  |  | if (i == j) | 
| 103 |  |  | m(i, j) = 1.0; | 
| 104 |  |  | else | 
| 105 |  |  | m(i, j) = 0.0; | 
| 106 | tim | 70 |  | 
| 107 | gezelter | 507 | return m; | 
| 108 |  |  | } | 
| 109 | tim | 74 |  | 
| 110 | gezelter | 507 | /** | 
| 111 |  |  | * Retunrs  the inversion of this matrix. | 
| 112 |  |  | * @todo need implementation | 
| 113 |  |  | */ | 
| 114 |  |  | SquareMatrix<Real, Dim>  inverse() { | 
| 115 |  |  | SquareMatrix<Real, Dim> result; | 
| 116 | tim | 70 |  | 
| 117 | gezelter | 507 | return result; | 
| 118 |  |  | } | 
| 119 | tim | 70 |  | 
| 120 | gezelter | 507 | /** | 
| 121 |  |  | * Returns the determinant of this matrix. | 
| 122 |  |  | * @todo need implementation | 
| 123 |  |  | */ | 
| 124 |  |  | Real determinant() const { | 
| 125 |  |  | Real det; | 
| 126 |  |  | return det; | 
| 127 |  |  | } | 
| 128 | tim | 70 |  | 
| 129 | gezelter | 507 | /** Returns the trace of this matrix. */ | 
| 130 |  |  | Real trace() const { | 
| 131 |  |  | Real tmp = 0; | 
| 132 | tim | 137 |  | 
| 133 | gezelter | 507 | for (unsigned int i = 0; i < Dim ; i++) | 
| 134 |  |  | tmp += this->data_[i][i]; | 
| 135 | tim | 70 |  | 
| 136 | gezelter | 507 | return tmp; | 
| 137 |  |  | } | 
| 138 | tim | 70 |  | 
| 139 | gezelter | 507 | /** Tests if this matrix is symmetrix. */ | 
| 140 |  |  | bool isSymmetric() const { | 
| 141 |  |  | for (unsigned int i = 0; i < Dim - 1; i++) | 
| 142 |  |  | for (unsigned int j = i; j < Dim; j++) | 
| 143 | gezelter | 956 | if (fabs(this->data_[i][j] - this->data_[j][i]) > epsilon) | 
| 144 | gezelter | 507 | return false; | 
| 145 | tim | 137 |  | 
| 146 | gezelter | 507 | return true; | 
| 147 |  |  | } | 
| 148 | tim | 70 |  | 
| 149 | gezelter | 507 | /** Tests if this matrix is orthogonal. */ | 
| 150 |  |  | bool isOrthogonal() { | 
| 151 |  |  | SquareMatrix<Real, Dim> tmp; | 
| 152 | tim | 70 |  | 
| 153 | gezelter | 507 | tmp = *this * transpose(); | 
| 154 | tim | 70 |  | 
| 155 | gezelter | 507 | return tmp.isDiagonal(); | 
| 156 |  |  | } | 
| 157 | tim | 70 |  | 
| 158 | gezelter | 507 | /** Tests if this matrix is diagonal. */ | 
| 159 |  |  | bool isDiagonal() const { | 
| 160 |  |  | for (unsigned int i = 0; i < Dim ; i++) | 
| 161 |  |  | for (unsigned int j = 0; j < Dim; j++) | 
| 162 | gezelter | 956 | if (i !=j && fabs(this->data_[i][j]) > epsilon) | 
| 163 | gezelter | 507 | return false; | 
| 164 | tim | 137 |  | 
| 165 | gezelter | 507 | return true; | 
| 166 |  |  | } | 
| 167 | tim | 137 |  | 
| 168 | gezelter | 507 | /** Tests if this matrix is the unit matrix. */ | 
| 169 |  |  | bool isUnitMatrix() const { | 
| 170 |  |  | if (!isDiagonal()) | 
| 171 |  |  | return false; | 
| 172 | tim | 70 |  | 
| 173 | gezelter | 507 | for (unsigned int i = 0; i < Dim ; i++) | 
| 174 | gezelter | 956 | if (fabs(this->data_[i][i] - 1) > epsilon) | 
| 175 | gezelter | 507 | return false; | 
| 176 | tim | 137 |  | 
| 177 | gezelter | 507 | return true; | 
| 178 |  |  | } | 
| 179 | tim | 70 |  | 
| 180 | gezelter | 507 | /** Return the transpose of this matrix */ | 
| 181 |  |  | SquareMatrix<Real,  Dim> transpose() const{ | 
| 182 |  |  | SquareMatrix<Real,  Dim> result; | 
| 183 | tim | 273 |  | 
| 184 | gezelter | 507 | for (unsigned int i = 0; i < Dim; i++) | 
| 185 |  |  | for (unsigned int j = 0; j < Dim; j++) | 
| 186 |  |  | result(j, i) = this->data_[i][j]; | 
| 187 | tim | 273 |  | 
| 188 | gezelter | 507 | return result; | 
| 189 |  |  | } | 
| 190 | tim | 273 |  | 
| 191 | gezelter | 507 | /** @todo need implementation */ | 
| 192 |  |  | void diagonalize() { | 
| 193 |  |  | //jacobi(m, eigenValues, ortMat); | 
| 194 |  |  | } | 
| 195 | tim | 76 |  | 
| 196 | gezelter | 507 | /** | 
| 197 |  |  | * Jacobi iteration routines for computing eigenvalues/eigenvectors of | 
| 198 |  |  | * real symmetric matrix | 
| 199 |  |  | * | 
| 200 |  |  | * @return true if success, otherwise return false | 
| 201 |  |  | * @param a symmetric matrix whose eigenvectors are to be computed. On return, the matrix is | 
| 202 |  |  | *     overwritten | 
| 203 |  |  | * @param w will contain the eigenvalues of the matrix On return of this function | 
| 204 |  |  | * @param v the columns of this matrix will contain the eigenvectors. The eigenvectors are | 
| 205 |  |  | *    normalized and mutually orthogonal. | 
| 206 |  |  | */ | 
| 207 | tim | 137 |  | 
| 208 | gezelter | 507 | static int jacobi(SquareMatrix<Real, Dim>& a, Vector<Real, Dim>& d, | 
| 209 |  |  | SquareMatrix<Real, Dim>& v); | 
| 210 |  |  | };//end SquareMatrix | 
| 211 | tim | 70 |  | 
| 212 | tim | 76 |  | 
| 213 | gezelter | 507 | /*========================================================================= | 
| 214 | tim | 76 |  | 
| 215 | tim | 123 | Program:   Visualization Toolkit | 
| 216 |  |  | Module:    $RCSfile: SquareMatrix.hpp,v $ | 
| 217 | tim | 76 |  | 
| 218 | tim | 123 | Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen | 
| 219 |  |  | All rights reserved. | 
| 220 |  |  | See Copyright.txt or http://www.kitware.com/Copyright.htm for details. | 
| 221 |  |  |  | 
| 222 | gezelter | 507 | This software is distributed WITHOUT ANY WARRANTY; without even | 
| 223 |  |  | the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR | 
| 224 |  |  | PURPOSE.  See the above copyright notice for more information. | 
| 225 | tim | 123 |  | 
| 226 | gezelter | 507 | =========================================================================*/ | 
| 227 | tim | 123 |  | 
| 228 | gezelter | 507 | #define VTK_ROTATE(a,i,j,k,l) g=a(i, j);h=a(k, l);a(i, j)=g-s*(h+g*tau); \ | 
| 229 |  |  | a(k, l)=h+s*(g-h*tau) | 
| 230 | tim | 123 |  | 
| 231 |  |  | #define VTK_MAX_ROTATIONS 20 | 
| 232 |  |  |  | 
| 233 | gezelter | 507 | // Jacobi iteration for the solution of eigenvectors/eigenvalues of a nxn | 
| 234 |  |  | // real symmetric matrix. Square nxn matrix a; size of matrix in n; | 
| 235 |  |  | // output eigenvalues in w; and output eigenvectors in v. Resulting | 
| 236 |  |  | // eigenvalues/vectors are sorted in decreasing order; eigenvectors are | 
| 237 |  |  | // normalized. | 
| 238 |  |  | template<typename Real, int Dim> | 
| 239 |  |  | int SquareMatrix<Real, Dim>::jacobi(SquareMatrix<Real, Dim>& a, Vector<Real, Dim>& w, | 
| 240 |  |  | SquareMatrix<Real, Dim>& v) { | 
| 241 |  |  | const int n = Dim; | 
| 242 |  |  | int i, j, k, iq, ip, numPos; | 
| 243 |  |  | Real tresh, theta, tau, t, sm, s, h, g, c, tmp; | 
| 244 |  |  | Real bspace[4], zspace[4]; | 
| 245 |  |  | Real *b = bspace; | 
| 246 |  |  | Real *z = zspace; | 
| 247 | tim | 123 |  | 
| 248 | gezelter | 507 | // only allocate memory if the matrix is large | 
| 249 |  |  | if (n > 4) { | 
| 250 |  |  | b = new Real[n]; | 
| 251 |  |  | z = new Real[n]; | 
| 252 |  |  | } | 
| 253 | tim | 123 |  | 
| 254 | gezelter | 507 | // initialize | 
| 255 |  |  | for (ip=0; ip<n; ip++) { | 
| 256 |  |  | for (iq=0; iq<n; iq++) { | 
| 257 |  |  | v(ip, iq) = 0.0; | 
| 258 |  |  | } | 
| 259 |  |  | v(ip, ip) = 1.0; | 
| 260 |  |  | } | 
| 261 |  |  | for (ip=0; ip<n; ip++) { | 
| 262 |  |  | b[ip] = w[ip] = a(ip, ip); | 
| 263 |  |  | z[ip] = 0.0; | 
| 264 |  |  | } | 
| 265 | tim | 76 |  | 
| 266 | gezelter | 507 | // begin rotation sequence | 
| 267 |  |  | for (i=0; i<VTK_MAX_ROTATIONS; i++) { | 
| 268 |  |  | sm = 0.0; | 
| 269 |  |  | for (ip=0; ip<n-1; ip++) { | 
| 270 |  |  | for (iq=ip+1; iq<n; iq++) { | 
| 271 |  |  | sm += fabs(a(ip, iq)); | 
| 272 |  |  | } | 
| 273 |  |  | } | 
| 274 |  |  | if (sm == 0.0) { | 
| 275 |  |  | break; | 
| 276 |  |  | } | 
| 277 | tim | 76 |  | 
| 278 | gezelter | 507 | if (i < 3) {                                // first 3 sweeps | 
| 279 |  |  | tresh = 0.2*sm/(n*n); | 
| 280 |  |  | } else { | 
| 281 |  |  | tresh = 0.0; | 
| 282 |  |  | } | 
| 283 | tim | 76 |  | 
| 284 | gezelter | 507 | for (ip=0; ip<n-1; ip++) { | 
| 285 |  |  | for (iq=ip+1; iq<n; iq++) { | 
| 286 |  |  | g = 100.0*fabs(a(ip, iq)); | 
| 287 | tim | 76 |  | 
| 288 | gezelter | 507 | // after 4 sweeps | 
| 289 |  |  | if (i > 3 && (fabs(w[ip])+g) == fabs(w[ip]) | 
| 290 |  |  | && (fabs(w[iq])+g) == fabs(w[iq])) { | 
| 291 |  |  | a(ip, iq) = 0.0; | 
| 292 |  |  | } else if (fabs(a(ip, iq)) > tresh) { | 
| 293 |  |  | h = w[iq] - w[ip]; | 
| 294 |  |  | if ( (fabs(h)+g) == fabs(h)) { | 
| 295 |  |  | t = (a(ip, iq)) / h; | 
| 296 |  |  | } else { | 
| 297 |  |  | theta = 0.5*h / (a(ip, iq)); | 
| 298 |  |  | t = 1.0 / (fabs(theta)+sqrt(1.0+theta*theta)); | 
| 299 |  |  | if (theta < 0.0) { | 
| 300 |  |  | t = -t; | 
| 301 |  |  | } | 
| 302 |  |  | } | 
| 303 |  |  | c = 1.0 / sqrt(1+t*t); | 
| 304 |  |  | s = t*c; | 
| 305 |  |  | tau = s/(1.0+c); | 
| 306 |  |  | h = t*a(ip, iq); | 
| 307 |  |  | z[ip] -= h; | 
| 308 |  |  | z[iq] += h; | 
| 309 |  |  | w[ip] -= h; | 
| 310 |  |  | w[iq] += h; | 
| 311 |  |  | a(ip, iq)=0.0; | 
| 312 | tim | 76 |  | 
| 313 | gezelter | 507 | // ip already shifted left by 1 unit | 
| 314 |  |  | for (j = 0;j <= ip-1;j++) { | 
| 315 |  |  | VTK_ROTATE(a,j,ip,j,iq); | 
| 316 |  |  | } | 
| 317 |  |  | // ip and iq already shifted left by 1 unit | 
| 318 |  |  | for (j = ip+1;j <= iq-1;j++) { | 
| 319 |  |  | VTK_ROTATE(a,ip,j,j,iq); | 
| 320 |  |  | } | 
| 321 |  |  | // iq already shifted left by 1 unit | 
| 322 |  |  | for (j=iq+1; j<n; j++) { | 
| 323 |  |  | VTK_ROTATE(a,ip,j,iq,j); | 
| 324 |  |  | } | 
| 325 |  |  | for (j=0; j<n; j++) { | 
| 326 |  |  | VTK_ROTATE(v,j,ip,j,iq); | 
| 327 |  |  | } | 
| 328 |  |  | } | 
| 329 |  |  | } | 
| 330 |  |  | } | 
| 331 | tim | 93 |  | 
| 332 | gezelter | 507 | for (ip=0; ip<n; ip++) { | 
| 333 |  |  | b[ip] += z[ip]; | 
| 334 |  |  | w[ip] = b[ip]; | 
| 335 |  |  | z[ip] = 0.0; | 
| 336 |  |  | } | 
| 337 |  |  | } | 
| 338 | tim | 93 |  | 
| 339 | gezelter | 507 | //// this is NEVER called | 
| 340 |  |  | if ( i >= VTK_MAX_ROTATIONS ) { | 
| 341 |  |  | std::cout << "vtkMath::Jacobi: Error extracting eigenfunctions" << std::endl; | 
| 342 |  |  | return 0; | 
| 343 |  |  | } | 
| 344 | tim | 76 |  | 
| 345 | gezelter | 507 | // sort eigenfunctions                 these changes do not affect accuracy | 
| 346 |  |  | for (j=0; j<n-1; j++) {                  // boundary incorrect | 
| 347 |  |  | k = j; | 
| 348 |  |  | tmp = w[k]; | 
| 349 |  |  | for (i=j+1; i<n; i++) {                // boundary incorrect, shifted already | 
| 350 |  |  | if (w[i] >= tmp) {                   // why exchage if same? | 
| 351 |  |  | k = i; | 
| 352 |  |  | tmp = w[k]; | 
| 353 |  |  | } | 
| 354 |  |  | } | 
| 355 |  |  | if (k != j) { | 
| 356 |  |  | w[k] = w[j]; | 
| 357 |  |  | w[j] = tmp; | 
| 358 |  |  | for (i=0; i<n; i++) { | 
| 359 |  |  | tmp = v(i, j); | 
| 360 |  |  | v(i, j) = v(i, k); | 
| 361 |  |  | v(i, k) = tmp; | 
| 362 |  |  | } | 
| 363 |  |  | } | 
| 364 |  |  | } | 
| 365 |  |  | // insure eigenvector consistency (i.e., Jacobi can compute vectors that | 
| 366 |  |  | // are negative of one another (.707,.707,0) and (-.707,-.707,0). This can | 
| 367 |  |  | // reek havoc in hyperstreamline/other stuff. We will select the most | 
| 368 |  |  | // positive eigenvector. | 
| 369 |  |  | int ceil_half_n = (n >> 1) + (n & 1); | 
| 370 |  |  | for (j=0; j<n; j++) { | 
| 371 |  |  | for (numPos=0, i=0; i<n; i++) { | 
| 372 |  |  | if ( v(i, j) >= 0.0 ) { | 
| 373 |  |  | numPos++; | 
| 374 |  |  | } | 
| 375 |  |  | } | 
| 376 | tim | 963 | //    if ( numPos < ceil(RealType(n)/RealType(2.0)) ) | 
| 377 | gezelter | 507 | if ( numPos < ceil_half_n) { | 
| 378 |  |  | for (i=0; i<n; i++) { | 
| 379 |  |  | v(i, j) *= -1.0; | 
| 380 |  |  | } | 
| 381 |  |  | } | 
| 382 |  |  | } | 
| 383 | tim | 76 |  | 
| 384 | gezelter | 507 | if (n > 4) { | 
| 385 |  |  | delete [] b; | 
| 386 |  |  | delete [] z; | 
| 387 | tim | 76 | } | 
| 388 | gezelter | 507 | return 1; | 
| 389 |  |  | } | 
| 390 | tim | 76 |  | 
| 391 |  |  |  | 
| 392 | tim | 963 | typedef SquareMatrix<RealType, 6> Mat6x6d; | 
| 393 | tim | 76 | } | 
| 394 | tim | 123 | #endif //MATH_SQUAREMATRIX_HPP | 
| 395 | tim | 76 |  |