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

Comparing:
trunk/src/perturbations/ElectricField.hpp (file contents), Revision 1782 by gezelter, Wed Aug 22 02:28:28 2012 UTC vs.
trunk/src/perturbations/UniformField.hpp (file contents), Revision 2020 by gezelter, Mon Sep 22 19:18:35 2014 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   */
42  
43 #ifndef PERTURBATIONS_ELECTRICFIELD_HPP
44 #define PERTURBATIONS_ELECTRICFIELD_HPP
43  
44 + /*! \file perturbations/UniformField.hpp
45 +    \brief Uniform Electric Field perturbation
46 + */
47 +
48 + #ifndef PERTURBATIONS_UNIFORMFIELD_HPP
49 + #define PERTURBATIONS_UNIFORMFIELD_HPP
50 +
51   #include "perturbations/Perturbation.hpp"
52   #include "brains/SimInfo.hpp"
53  
54   namespace OpenMD {
55    
56 <  /**
57 <   * @class ElectricFieldForceManager
58 <   * Perturbation for external Electric Field forces and torques.
59 <   */
60 <  class ElectricField : public Perturbation {
56 >  //! Applies a uniform (vector) electric field to the system
57 >  /*! The field is applied as an external perturbation.  The user specifies
58 >
59 >  \code{.unparsed}
60 >    uniformField = (ex, ey, ez);
61 >  \endcode
62      
63 +    in the .md file where the values of ex, ey, and ez are in units of
64 +    \f$ V / \AA \f$
65 +
66 +   The external field applies a force on charged atoms, \f$ \mathbf{F}
67 +   = C \mathbf{E} \f$.  For dipolar atoms, the field applies both a
68 +   potential, \f$ U = - \mathbf{D} \cdot \mathbf{E} \f$ and a torque,
69 +   \f$ \mathbf{\tau} = \mathbf{D} \times \mathbf{E} \f$.
70 +  */
71 +  class UniformField : public Perturbation {
72 +    
73    public:
74 <    ElectricField(SimInfo* info);
74 >    UniformField(SimInfo* info);
75      
76    protected:
77      virtual void initialize();
# Line 63 | Line 79 | namespace OpenMD {
79      
80    private:
81      bool initialized;
82 <    bool doElectricField;
82 >    bool doUniformField;
83      bool doParticlePot;
84      Globals* simParams;
85      SimInfo* info_;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines