ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/src/hydrodynamics/HydroProp.hpp
(Generate patch)

Comparing:
trunk/src/hydrodynamics/HydroProp.hpp (file contents), Revision 981 by gezelter, Mon Jun 5 18:24:45 2006 UTC vs.
branches/development/src/hydrodynamics/HydroProp.hpp (file contents), Revision 1874 by gezelter, Wed May 15 15:09:35 2013 UTC

# Line 6 | Line 6
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
9 > * 1. Redistributions of source code must retain the above copyright
10   *    notice, this list of conditions and the following disclaimer.
11   *
12 < * 3. Redistributions in binary form must reproduce the above copyright
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.
# Line 37 | Line 28
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, 234107 (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   #ifndef HYDRODYNAMICS_HYDROPROP_HPP
44   #define HYDRODYNAMICS_HYDROPROP_HPP
45   #include "math/Vector3.hpp"
46   #include "math/SquareMatrix3.hpp"
47 < namespace oopse {
47 > namespace OpenMD {
48  
49 +  /**
50 +   * @class HydroProp HydroProp.hpp "hydrodynamics/HydroProp.hpp"
51 +   * Container for information about the hydrodynamic behavior of objects
52 +   * undergoing Langevin dynamics.
53 +   * @note the units for the center of resistance (a location) are in Angstroms
54 +   *
55 +   * @note the units of Xi, the resistance tensor are:
56 +   *    Xitt (Translation-translation) : kcal fs mol^-1 Angstroms^-2
57 +   *    Xirt (Rotation-translation) : kcal fs mol^-1 Angstroms^-1 radians^-1
58 +   *    Xitr (Translation-rotation) : kcal fs mol^-1 Angstroms^-1 radians^-1
59 +   *    Xirr (Rotation-rotation) : kcal fs mol^-1 radians^-2
60 +   *
61 +   * @note the units of D, the diffusion tensor are:
62 +   *    Dtt (Translation-translation) : Angstroms^2 fs^-1
63 +   *    Drt (Rotation-translation) :    Angstroms fs^-1
64 +   *    Dtr (Translation-rotation) :    Angstroms fs^-1
65 +   *    Drr (Rotation-rotation) :       fs^-1
66 +   *  
67 +   * @note after setting the value of Xi manually, the complete() function
68 +   * should be called to perform the Cholesky Decomposition.
69 +   */
70    class HydroProp {
71  
72    public:
73      HydroProp();
74      HydroProp(Vector3d cor, Mat6x6d Xi, Mat6x6d D);
75 <    HydroProp(const std::string frictionLine);
75 >    HydroProp(const std::string &frictionLine);
76      ~HydroProp() { } ;
77      void complete();
78      void setCOR(Vector3d cor) {cor_ = cor; hasCOR = true;}

Comparing:
trunk/src/hydrodynamics/HydroProp.hpp (property svn:keywords), Revision 981 by gezelter, Mon Jun 5 18:24:45 2006 UTC vs.
branches/development/src/hydrodynamics/HydroProp.hpp (property svn:keywords), Revision 1874 by gezelter, Wed May 15 15:09:35 2013 UTC

# Line 0 | Line 1
1 + Author Id Revision Date

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines