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

Comparing branches/development/src/brains/Thermo.hpp (file contents):
Revision 1794 by gezelter, Thu Sep 6 19:44:06 2012 UTC vs.
Revision 1866 by gezelter, Thu Apr 25 14:32:56 2013 UTC

# Line 35 | Line 35
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).          
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   */
# Line 67 | Line 67 | namespace OpenMD {
67  
68      RealType getPressure(); // gives the instant pressure in atm;
69  
70 <    // gives the pressure tensor in amu*fs^-2*Ang^-1
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 <    // accumulate and return the simulation box dipole moment in C*m
74 >    /** \brief accumulate and return the simulation box dipole moment in C*m */
75      Vector3d getSystemDipole();
76      Vector3d getHeatFlux();
77  
78 <    /** Returns the center of the mass of the whole system.*/
78 >    /** \brief Returns the center of the mass of the whole system.*/
79      Vector3d getCom();
80  
81 <    /** Returns the velocity of center of mass of the whole system.*/
81 >    /** \brief Returns the velocity of center of mass of the whole system.*/
82      Vector3d getComVel();
83  
84 <    /** Returns the center of the mass and Center of Mass velocity of
84 >    /** \brief Returns the center of the mass and Center of Mass velocity of
85          the whole system.*/
86      void getComAll(Vector3d& com,Vector3d& comVel);
87  
88 <    /** Returns intertia tensor for the entire system and system
89 <        Angular Momentum.*/
90 <    void getInertiaTensor(Mat3x3d &intertiaTensor,Vector3d &angularMomentum);
88 >    /** \brief Returns the inertia tensor and the total angular
89 >        momentum for for the entire system
90 >     * \param[out] inertiaTensor the inertia tensor
91 >     * \param[out] angularMomentum the angular momentum vector
92 >     * \ingroup surface
93 >     */
94 >    void getInertiaTensor(Mat3x3d &inertiaTensor,Vector3d &angularMomentum);
95      
96 <    /** Returns system angular momentum */
96 >    /** \brief Returns the Axis-aligned bounding box for the current system.
97 >     */
98 >    Mat3x3d getBoundingBox();
99 >
100 >    /** \brief Returns system angular momentum */
101      Vector3d getAngularMomentum();
102  
103 <    /** Returns volume of system as estimated by an ellipsoid defined
103 >    /** \brief Returns volume of system as estimated by an ellipsoid defined
104          by the radii of gyration */
105      RealType getGyrationalVolume();
106  
107 <    /** Overloaded version of gyrational volume that also returns
107 >    /** \brief Overloaded version of gyrational volume that also returns
108          det(I) so dV/dr can be calculated */
109      void getGyrationalVolume(RealType &vol, RealType &detI);
110  
# Line 105 | Line 113 | namespace OpenMD {
113      RealType getTaggedAtomPairDistance();
114      
115    private:    
108  private:    
116      SimInfo* info_;
117    };
118    

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines