| 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]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010). | 
| 40 | * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011). | 
| 41 | */ | 
| 42 |  | 
| 43 | #include "applications/staticProps/P2OrderParameter.hpp" | 
| 44 | #include "utils/simError.h" | 
| 45 | #include "io/DumpReader.hpp" | 
| 46 | #include "primitives/Molecule.hpp" | 
| 47 | #include "utils/NumericConstant.hpp" | 
| 48 |  | 
| 49 | using namespace std; | 
| 50 | namespace OpenMD { | 
| 51 |  | 
| 52 | P2OrderParameter::P2OrderParameter(SimInfo* info, const string& filename, | 
| 53 | const string& sele1) | 
| 54 | : StaticAnalyser(info, filename), doVect_(true), doOffset_(false), | 
| 55 | selectionScript1_(sele1), evaluator1_(info), | 
| 56 | evaluator2_(info), seleMan1_(info), seleMan2_(info) { | 
| 57 |  | 
| 58 | setOutputName(getPrefix(filename) + ".p2"); | 
| 59 |  | 
| 60 | evaluator1_.loadScriptString(sele1); | 
| 61 | } | 
| 62 |  | 
| 63 | P2OrderParameter::P2OrderParameter(SimInfo* info, const string& filename, | 
| 64 | const string& sele1, const string& sele2) | 
| 65 | : StaticAnalyser(info, filename), doVect_(false), doOffset_(false), | 
| 66 | selectionScript1_(sele1), selectionScript2_(sele2), evaluator1_(info), | 
| 67 | evaluator2_(info), seleMan1_(info), seleMan2_(info) { | 
| 68 |  | 
| 69 | setOutputName(getPrefix(filename) + ".p2"); | 
| 70 |  | 
| 71 | evaluator1_.loadScriptString(sele1); | 
| 72 | evaluator2_.loadScriptString(sele2); | 
| 73 | } | 
| 74 |  | 
| 75 | P2OrderParameter::P2OrderParameter(SimInfo* info, const string& filename, | 
| 76 | const string& sele1, int seleOffset) | 
| 77 | : StaticAnalyser(info, filename), doVect_(false), doOffset_(true), | 
| 78 | seleOffset_(seleOffset), selectionScript1_(sele1), evaluator1_(info), | 
| 79 | evaluator2_(info), seleMan1_(info), seleMan2_(info) { | 
| 80 |  | 
| 81 | setOutputName(getPrefix(filename) + ".p2"); | 
| 82 |  | 
| 83 | evaluator1_.loadScriptString(sele1); | 
| 84 | } | 
| 85 |  | 
| 86 | void P2OrderParameter::process() { | 
| 87 | Molecule* mol; | 
| 88 | RigidBody* rb; | 
| 89 | SimInfo::MoleculeIterator mi; | 
| 90 | Molecule::RigidBodyIterator rbIter; | 
| 91 | StuntDouble* sd1; | 
| 92 | StuntDouble* sd2; | 
| 93 | int ii; | 
| 94 | int jj; | 
| 95 | int vecCount; | 
| 96 |  | 
| 97 | DumpReader reader(info_, dumpFilename_); | 
| 98 | int nFrames = reader.getNFrames(); | 
| 99 |  | 
| 100 | for (int i = 0; i < nFrames; i += step_) { | 
| 101 | reader.readFrame(i); | 
| 102 | currentSnapshot_ = info_->getSnapshotManager()->getCurrentSnapshot(); | 
| 103 |  | 
| 104 | for (mol = info_->beginMolecule(mi); mol != NULL; | 
| 105 | mol = info_->nextMolecule(mi)) { | 
| 106 | //change the positions of atoms which belong to the rigidbodies | 
| 107 | for (rb = mol->beginRigidBody(rbIter); rb != NULL; | 
| 108 | rb = mol->nextRigidBody(rbIter)) { | 
| 109 | rb->updateAtoms(); | 
| 110 | } | 
| 111 | } | 
| 112 |  | 
| 113 | Mat3x3d orderTensor(0.0); | 
| 114 | vecCount = 0; | 
| 115 |  | 
| 116 | seleMan1_.setSelectionSet(evaluator1_.evaluate()); | 
| 117 |  | 
| 118 | if (doVect_) { | 
| 119 |  | 
| 120 | for (sd1 = seleMan1_.beginSelected(ii); sd1 != NULL; | 
| 121 | sd1 = seleMan1_.nextSelected(ii)) { | 
| 122 | if (sd1->isDirectional()) { | 
| 123 | Vector3d vec = sd1->getA().getColumn(2); | 
| 124 | vec.normalize(); | 
| 125 | orderTensor += outProduct(vec, vec); | 
| 126 | vecCount++; | 
| 127 | } | 
| 128 | } | 
| 129 |  | 
| 130 | orderTensor /= vecCount; | 
| 131 |  | 
| 132 | } else { | 
| 133 |  | 
| 134 | if (doOffset_) { | 
| 135 |  | 
| 136 | for (sd1 = seleMan1_.beginSelected(ii); sd1 != NULL; | 
| 137 | sd1 = seleMan1_.nextSelected(ii)) { | 
| 138 |  | 
| 139 | // This will require careful rewriting if StaticProps is | 
| 140 | // ever parallelized.  For an example, see | 
| 141 | // Thermo::getTaggedAtomPairDistance | 
| 142 |  | 
| 143 | int sd2Index = sd1->getGlobalIndex() + seleOffset_; | 
| 144 | sd2 = info_->getIOIndexToIntegrableObject(sd2Index); | 
| 145 |  | 
| 146 | Vector3d vec = sd1->getPos() - sd2->getPos(); | 
| 147 |  | 
| 148 | if (usePeriodicBoundaryConditions_) | 
| 149 | currentSnapshot_->wrapVector(vec); | 
| 150 |  | 
| 151 | vec.normalize(); | 
| 152 |  | 
| 153 | orderTensor +=outProduct(vec, vec); | 
| 154 | vecCount++; | 
| 155 | } | 
| 156 |  | 
| 157 | orderTensor /= vecCount; | 
| 158 | } else { | 
| 159 |  | 
| 160 | seleMan2_.setSelectionSet(evaluator2_.evaluate()); | 
| 161 |  | 
| 162 | if (seleMan1_.getSelectionCount() != seleMan2_.getSelectionCount() ) { | 
| 163 | sprintf( painCave.errMsg, | 
| 164 | "In frame %d, the number of selected StuntDoubles are\n" | 
| 165 | "\tnot the same in --sele1 and sele2\n", i); | 
| 166 | painCave.severity = OPENMD_INFO; | 
| 167 | painCave.isFatal = 0; | 
| 168 | simError(); | 
| 169 | } | 
| 170 |  | 
| 171 | for (sd1 = seleMan1_.beginSelected(ii), | 
| 172 | sd2 = seleMan2_.beginSelected(jj); | 
| 173 | sd1 != NULL && sd2 != NULL; | 
| 174 | sd1 = seleMan1_.nextSelected(ii), | 
| 175 | sd2 = seleMan2_.nextSelected(jj)) { | 
| 176 |  | 
| 177 | Vector3d vec = sd1->getPos() - sd2->getPos(); | 
| 178 |  | 
| 179 | if (usePeriodicBoundaryConditions_) | 
| 180 | currentSnapshot_->wrapVector(vec); | 
| 181 |  | 
| 182 | vec.normalize(); | 
| 183 |  | 
| 184 | orderTensor +=outProduct(vec, vec); | 
| 185 | vecCount++; | 
| 186 | } | 
| 187 |  | 
| 188 | orderTensor /= vecCount; | 
| 189 | } | 
| 190 | } | 
| 191 |  | 
| 192 | if (vecCount == 0) { | 
| 193 | sprintf( painCave.errMsg, | 
| 194 | "In frame %d, the number of selected vectors was zero.\n" | 
| 195 | "\tThis will not give a meaningful order parameter.", i); | 
| 196 | painCave.severity = OPENMD_ERROR; | 
| 197 | painCave.isFatal = 1; | 
| 198 | simError(); | 
| 199 | } | 
| 200 |  | 
| 201 | orderTensor -= (RealType)(1.0/3.0) * Mat3x3d::identity(); | 
| 202 |  | 
| 203 | Vector3d eigenvalues; | 
| 204 | Mat3x3d eigenvectors; | 
| 205 |  | 
| 206 | Mat3x3d::diagonalize(orderTensor, eigenvalues, eigenvectors); | 
| 207 |  | 
| 208 | int which; | 
| 209 | RealType maxEval = 0.0; | 
| 210 | for(int k = 0; k< 3; k++){ | 
| 211 | if(fabs(eigenvalues[k]) > maxEval){ | 
| 212 | which = k; | 
| 213 | maxEval = fabs(eigenvalues[k]); | 
| 214 | } | 
| 215 | } | 
| 216 | RealType p2 = 1.5 * maxEval; | 
| 217 |  | 
| 218 | //the eigen vector is already normalized in SquareMatrix3::diagonalize | 
| 219 | Vector3d director = eigenvectors.getColumn(which); | 
| 220 | if (director[0] < 0) { | 
| 221 | director.negate(); | 
| 222 | } | 
| 223 |  | 
| 224 | RealType angle = 0.0; | 
| 225 | vecCount = 0; | 
| 226 |  | 
| 227 | if (doVect_) { | 
| 228 | for (sd1 = seleMan1_.beginSelected(ii); sd1 != NULL; | 
| 229 | sd1 = seleMan1_.nextSelected(ii)) { | 
| 230 | if (sd1->isDirectional()) { | 
| 231 | Vector3d vec = sd1->getA().getColumn(2); | 
| 232 | vec.normalize(); | 
| 233 | angle += acos(dot(vec, director)); | 
| 234 | vecCount++; | 
| 235 | } | 
| 236 | } | 
| 237 | angle = angle/(vecCount*NumericConstant::PI)*180.0; | 
| 238 |  | 
| 239 | } else { | 
| 240 | if (doOffset_) { | 
| 241 |  | 
| 242 | for (sd1 = seleMan1_.beginSelected(ii); sd1 != NULL; | 
| 243 | sd1 = seleMan1_.nextSelected(ii)) { | 
| 244 |  | 
| 245 | // This will require careful rewriting if StaticProps is | 
| 246 | // ever parallelized.  For an example, see | 
| 247 | // Thermo::getTaggedAtomPairDistance | 
| 248 |  | 
| 249 | int sd2Index = sd1->getGlobalIndex() + seleOffset_; | 
| 250 | sd2 = info_->getIOIndexToIntegrableObject(sd2Index); | 
| 251 |  | 
| 252 | Vector3d vec = sd1->getPos() - sd2->getPos(); | 
| 253 | if (usePeriodicBoundaryConditions_) | 
| 254 | currentSnapshot_->wrapVector(vec); | 
| 255 | vec.normalize(); | 
| 256 | angle += acos(dot(vec, director)) ; | 
| 257 | vecCount++; | 
| 258 | } | 
| 259 | angle = angle / (vecCount * NumericConstant::PI) * 180.0; | 
| 260 |  | 
| 261 | } else { | 
| 262 |  | 
| 263 | for (sd1 = seleMan1_.beginSelected(ii), | 
| 264 | sd2 = seleMan2_.beginSelected(jj); | 
| 265 | sd1 != NULL && sd2 != NULL; | 
| 266 | sd1 = seleMan1_.nextSelected(ii), | 
| 267 | sd2 = seleMan2_.nextSelected(jj)) { | 
| 268 |  | 
| 269 | Vector3d vec = sd1->getPos() - sd2->getPos(); | 
| 270 | if (usePeriodicBoundaryConditions_) | 
| 271 | currentSnapshot_->wrapVector(vec); | 
| 272 | vec.normalize(); | 
| 273 | angle += acos(dot(vec, director)) ; | 
| 274 | vecCount++; | 
| 275 | } | 
| 276 | angle = angle / (vecCount * NumericConstant::PI) * 180.0; | 
| 277 | } | 
| 278 | } | 
| 279 |  | 
| 280 | OrderParam param; | 
| 281 | param.p2 = p2; | 
| 282 | param.director = director; | 
| 283 | param.angle = angle; | 
| 284 |  | 
| 285 | orderParams_.push_back(param); | 
| 286 |  | 
| 287 | } | 
| 288 |  | 
| 289 | writeP2(); | 
| 290 |  | 
| 291 | } | 
| 292 |  | 
| 293 | void P2OrderParameter::writeP2() { | 
| 294 |  | 
| 295 | ofstream os(getOutputFileName().c_str()); | 
| 296 | os << "#radial distribution function\n"; | 
| 297 | os<< "#selection1: (" << selectionScript1_ << ")\t"; | 
| 298 | if (!doVect_) { | 
| 299 | os << "selection2: (" << selectionScript2_ << ")\n"; | 
| 300 | } | 
| 301 | os << "#p2\tdirector_x\tdirector_y\tdiretor_z\tangle(degree)\n"; | 
| 302 |  | 
| 303 | for (size_t i = 0; i < orderParams_.size(); ++i) { | 
| 304 | os <<  orderParams_[i].p2 << "\t" | 
| 305 | <<  orderParams_[i].director[0] << "\t" | 
| 306 | <<  orderParams_[i].director[1] << "\t" | 
| 307 | <<  orderParams_[i].director[2] << "\t" | 
| 308 | <<  orderParams_[i].angle << "\n"; | 
| 309 |  | 
| 310 | } | 
| 311 |  | 
| 312 | } | 
| 313 |  | 
| 314 | } | 
| 315 |  |