| 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. Acknowledgement of the program authors must be made in any |
| 10 |
* publication of scientific results based in part on use of the |
| 11 |
* program. An acceptable form of acknowledgement is citation of |
| 12 |
* the article in which the program was described (Matthew |
| 13 |
* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher |
| 14 |
* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented |
| 15 |
* Parallel Simulation Engine for Molecular Dynamics," |
| 16 |
* J. Comput. Chem. 26, pp. 252-271 (2005)) |
| 17 |
* |
| 18 |
* 2. Redistributions of source code must retain the above copyright |
| 19 |
* notice, this list of conditions and the following disclaimer. |
| 20 |
* |
| 21 |
* 3. Redistributions in binary form must reproduce the above copyright |
| 22 |
* notice, this list of conditions and the following disclaimer in the |
| 23 |
* documentation and/or other materials provided with the |
| 24 |
* distribution. |
| 25 |
* |
| 26 |
* This software is provided "AS IS," without a warranty of any |
| 27 |
* kind. All express or implied conditions, representations and |
| 28 |
* warranties, including any implied warranty of merchantability, |
| 29 |
* fitness for a particular purpose or non-infringement, are hereby |
| 30 |
* excluded. The University of Notre Dame and its licensors shall not |
| 31 |
* be liable for any damages suffered by licensee as a result of |
| 32 |
* using, modifying or distributing the software or its |
| 33 |
* derivatives. In no event will the University of Notre Dame or its |
| 34 |
* licensors be liable for any lost revenue, profit or data, or for |
| 35 |
* direct, indirect, special, consequential, incidental or punitive |
| 36 |
* damages, however caused and regardless of the theory of liability, |
| 37 |
* arising out of the use of or inability to use software, even if the |
| 38 |
* University of Notre Dame has been advised of the possibility of |
| 39 |
* such damages. |
| 40 |
*/ |
| 41 |
|
| 42 |
#ifndef HYDRODYNAMICS_HYDROPROP_HPP |
| 43 |
#define HYDRODYNAMICS_HYDROPROP_HPP |
| 44 |
#include "math/Vector3.hpp" |
| 45 |
#include "math/SquareMatrix3.hpp" |
| 46 |
namespace oopse { |
| 47 |
|
| 48 |
/** |
| 49 |
* @class HydroProp HydroProp.hpp "hydrodynamics/HydroProp.hpp" |
| 50 |
* Container for information about the hydrodynamic behavior of objects |
| 51 |
* undergoing Langevin dynamics. |
| 52 |
* @note the units for the center of resistance (a location) are in Angstroms |
| 53 |
* |
| 54 |
* @note the units of Xi, the resistance tensor are: |
| 55 |
* Xitt (Translation-translation) : kcal fs mol^-1 Angstroms^-2 |
| 56 |
* Xirt (Rotation-translation) : kcal fs mol^-1 Angstroms^-1 radians^-1 |
| 57 |
* Xitr (Translation-rotation) : kcal fs mol^-1 Angstroms^-1 radians^-1 |
| 58 |
* Xirr (Rotation-rotation) : kcal fs mol^-1 radians^-2 |
| 59 |
* |
| 60 |
* @note the units of D, the diffusion tensor are: |
| 61 |
* Dtt (Translation-translation) : Angstroms^2 fs^-1 |
| 62 |
* Drt (Rotation-translation) : Angstroms fs^-1 |
| 63 |
* Dtr (Translation-rotation) : Angstroms fs^-1 |
| 64 |
* Drr (Rotation-rotation) : fs^-1 |
| 65 |
* |
| 66 |
* @note after setting the value of Xi manually, the complete() function |
| 67 |
* should be called to perform the Cholesky Decomposition. |
| 68 |
*/ |
| 69 |
class HydroProp { |
| 70 |
|
| 71 |
public: |
| 72 |
HydroProp(); |
| 73 |
HydroProp(Vector3d cor, Mat6x6d Xi, Mat6x6d D); |
| 74 |
HydroProp(const std::string frictionLine); |
| 75 |
~HydroProp() { } ; |
| 76 |
void complete(); |
| 77 |
void setCOR(Vector3d cor) {cor_ = cor; hasCOR = true;} |
| 78 |
void setXi(Mat6x6d Xi) {Xi_ = Xi; hasXi = true;} |
| 79 |
void setD(Mat6x6d D) {D_ = D;} |
| 80 |
void setName(std::string name) {name_ = name;} |
| 81 |
|
| 82 |
Vector3d getCOR() {return cor_;} |
| 83 |
Mat3x3d getXitt() {return Xitt_;} |
| 84 |
Mat3x3d getXitr() {return Xitr_;} |
| 85 |
Mat3x3d getXirt() {return Xirt_;} |
| 86 |
Mat3x3d getXirr() {return Xirr_;} |
| 87 |
Mat6x6d getS() {return S_;} |
| 88 |
Mat6x6d getD() {return D_;} |
| 89 |
Mat6x6d getXi() {return Xi_;} |
| 90 |
std::string getName() {return name_;} |
| 91 |
|
| 92 |
private: |
| 93 |
|
| 94 |
std::string name_; |
| 95 |
Vector3d cor_; |
| 96 |
Mat6x6d Xi_; |
| 97 |
Mat6x6d D_; |
| 98 |
Mat3x3d Xitt_; |
| 99 |
Mat3x3d Xirt_; //Xirrt == Xirtr |
| 100 |
Mat3x3d Xitr_; |
| 101 |
Mat3x3d Xirr_; |
| 102 |
Mat6x6d S_; |
| 103 |
bool hasCOR; |
| 104 |
bool hasXi; |
| 105 |
|
| 106 |
}; |
| 107 |
} |
| 108 |
|
| 109 |
#endif |
