ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/src/brains/Thermo.hpp
(Generate patch)

Comparing trunk/src/brains/Thermo.hpp (file contents):
Revision 945 by gezelter, Tue Apr 25 02:09:01 2006 UTC vs.
Revision 2022 by gezelter, Fri Sep 26 22:22:28 2014 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 BRAINS_THERMO_HPP
# Line 45 | Line 46
46   #include "primitives/Atom.hpp"
47   #include "brains/SimInfo.hpp"
48  
49 < namespace oopse {
49 > namespace OpenMD {
50  
51    class Thermo{
52  
53    public:
54  
55 <    Thermo( SimInfo* info) : info_(info) {}
55 >    Thermo( SimInfo* info ) : info_(info) {}
56  
57      // note: all the following energies are in kcal/mol
58  
59 <    double getKinetic(); // the total kinetic energy
60 <    double getPotential(); // the total potential energy
61 <    double getTotalE(); // gets the total energy
59 >    RealType getTranslationalKinetic(); // the translational kinetic energy
60 >    RealType getRotationalKinetic(); // the rotational kinetic energy
61 >    RealType getKinetic(); // the total kinetic energy
62 >    RealType getPotential(); // the total potential energy
63 >    RealType getTotalEnergy(); // gets the total energy
64  
65 <    double getTemperature(); // gives the instant temp. in K
65 >    RealType getTemperature(); // Gives the instant temp. in K
66 >    RealType getElectronicTemperature(); // gives the instant electronic temperature in K
67  
68 <    double getPressure(); // gives the instant pressure in atm;
69 <    double getPressureX() { return getPressure(0); }
70 <    double getPressureY() { return getPressure(1); }
71 <    double getPressureZ() { return getPressure(2); }
68 >    RealType getPressure(); // gives the instant pressure in atm;
69 >
70 >    /** \brief gives the pressure tensor in amu*fs^-2*Ang^-1 */
71 >    Mat3x3d  getPressureTensor();
72 >    RealType getVolume();   // gives the volume in Ang^3
73 >
74 >    /** \brief accumulate and return the simulation box dipole moment in C*m */
75 >    Vector3d getSystemDipole();
76 >
77 >    /** \brief accumulate and return the simulation box dipole moment in debye Angstroms */
78 >    Mat3x3d getSystemQuadrupole();
79 >
80 >    Vector3d getHeatFlux();
81      
82 <    Mat3x3d getPressureTensor(); // gives the pressure  tensor in amu*fs^-2*Ang^-1
83 <    double getVolume();   // gives the volume in Ang^3
82 >    /** \brief Returns the center of the mass of the whole system.*/
83 >    Vector3d getCom();
84 >
85 >    /** \brief Returns the velocity of center of mass of the whole system.*/
86 >    Vector3d getComVel();
87 >
88 >    /** \brief Returns the center of the mass and Center of Mass velocity of
89 >        the whole system.*/
90 >    void getComAll(Vector3d& com,Vector3d& comVel);
91 >
92 >    /** \brief Returns the inertia tensor and the total angular
93 >        momentum for for the entire system
94 >     * \param[out] inertiaTensor the inertia tensor
95 >     * \param[out] angularMomentum the angular momentum vector
96 >     * \ingroup surface
97 >     */
98 >    void getInertiaTensor(Mat3x3d &inertiaTensor,Vector3d &angularMomentum);
99      
100 <    void saveStat();
100 >    /** \brief Returns the Axis-aligned bounding box for the current system.
101 >     */
102 >    Mat3x3d getBoundingBox();
103 >
104 >    /** \brief Returns system angular momentum */
105 >    Vector3d getAngularMomentum();
106 >
107 >    /** \brief Returns volume of system as estimated by an ellipsoid defined
108 >        by the radii of gyration */
109 >    RealType getGyrationalVolume();
110 >
111 >    /** \brief Overloaded version of gyrational volume that also returns
112 >        det(I) so dV/dr can be calculated */
113 >    void getGyrationalVolume(RealType &vol, RealType &detI);
114 >
115 >    RealType getHullVolume();
116 >
117 >    RealType getTaggedAtomPairDistance();
118      
119 <  private:
75 <    double getPressure(int direction);
76 <    
119 >  private:    
120      SimInfo* info_;
121    };
122    
123 < } //end namespace oopse
123 > } //end namespace OpenMD
124   #endif

Comparing trunk/src/brains/Thermo.hpp (property svn:keywords):
Revision 945 by gezelter, Tue Apr 25 02:09:01 2006 UTC vs.
Revision 2022 by gezelter, Fri Sep 26 22:22:28 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines