src/integrators/VelocityVerletIntegrator.cpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
/**
 * @file VelocityVerletIntegrator.cpp
 * @author tlin
 * @date 11/09/2004
 * @version 1.0
 */

#include "integrators/VelocityVerletIntegrator.hpp"
#include "integrators/DLM.hpp"
#include "utils/StringUtils.hpp"
#include "utils/ProgressBar.hpp"

namespace OpenMD {
  VelocityVerletIntegrator::VelocityVerletIntegrator(SimInfo *info) : Integrator(info) { 
    dt2 = 0.5 * dt;
  }
  
  VelocityVerletIntegrator::~VelocityVerletIntegrator() { 
  }
  
  void VelocityVerletIntegrator::initialize(){
    
    forceMan_->initialize();
    
    // remove center of mass drift velocity (in case we passed in a
    // configuration that was drifting)
    velocitizer_->removeComDrift();

    // find the initial fluctuating charges.
    flucQ_->initialize();
    
    // initialize the forces before the first step
    calcForce();
    
    // execute the constraint algorithm to make sure that the system is
    // constrained at the very beginning  
    if (info_->getNGlobalConstraints() > 0) {
      rattle_->constraintA();
      calcForce();
      rattle_->constraintB();      
      //copy the current snapshot to previous snapshot
      info_->getSnapshotManager()->advance();
    }
    
    if (needVelocityScaling) {
      velocitizer_->velocitize(targetScalingTemp);
    }
    
    dumpWriter = createDumpWriter();
    
    statWriter = createStatWriter();
 
    dumpWriter->writeDumpAndEor();

    progressBar = new ProgressBar();

    //save statistics, before writeStat,  we must save statistics
    saveConservedQuantity();
    stats->collectStats();

    if (simParams->getRNEMDParameters()->getUseRNEMD())
      rnemd_->getStarted();

    statWriter->writeStat();
    
    currSample = sampleTime + snap->getTime();
    currStatus =  statusTime + snap->getTime();
    currThermal = thermalTime + snap->getTime();
    if (needReset) {
      currReset = resetTime + snap->getTime();
    }
    if (simParams->getRNEMDParameters()->getUseRNEMD()){
      currRNEMD = RNEMD_exchangeTime + snap->getTime();
    }
    needPotential = false;
    needStress = false;       
    
  }
 
  void VelocityVerletIntegrator::doIntegrate() {
  
    initialize();
  
    while (snap->getTime() < runTime) {    
      preStep();    
      integrateStep();    
      postStep();      
    }  
    finalize();
  }


  void VelocityVerletIntegrator::preStep() {
    RealType difference = snap->getTime() + dt - currStatus;
  
    if (difference > 0 || fabs(difference) < OpenMD::epsilon) {
      needPotential = true;
      needStress = true;   
    }
  }

  void VelocityVerletIntegrator::postStep() {

    //save snapshot
    info_->getSnapshotManager()->advance();
  
    //increase time
    snap->increaseTime(dt);        
   
    if (needVelocityScaling) {
      if (snap->getTime() >= currThermal) {
        velocitizer_->velocitize(targetScalingTemp);
        currThermal += thermalTime;
      }
    }
    if (useRNEMD) {
      if (snap->getTime() >= currRNEMD) {
        rnemd_->doRNEMD();
        currRNEMD += RNEMD_exchangeTime;
      }
      rnemd_->collectData();
    }
    
    if (snap->getTime() >= currSample) {
      dumpWriter->writeDumpAndEor();
      
      currSample += sampleTime;
    }
    
    if (snap->getTime() >= currStatus) {
      //save statistics, before writeStat,  we must save statistics
      stats->collectStats();
      saveConservedQuantity();

      if (simParams->getRNEMDParameters()->getUseRNEMD()) {
        rnemd_->writeOutputFile();
      }

      statWriter->writeStat();

      progressBar->setStatus(snap->getTime(), runTime);
      progressBar->update();

      needPotential = false;
      needStress = false;
      currStatus += statusTime;
    }
    
    if (needReset && snap->getTime() >= currReset) {    
      resetIntegrator();
      currReset += resetTime;
    }        
  }


  void VelocityVerletIntegrator::finalize() {
    dumpWriter->writeEor();
    if (simParams->getRNEMDParameters()->getUseRNEMD()) {
      rnemd_->writeOutputFile();
    }
 
    delete dumpWriter;
    delete statWriter;
  
    dumpWriter = NULL;
    statWriter = NULL;
  }

  void VelocityVerletIntegrator::integrateStep() { 
  
    moveA();
    calcForce();
    moveB();
  }


  void VelocityVerletIntegrator::calcForce() { 
    forceMan_->calcForces();
    flucQ_->applyConstraints();
  }

  DumpWriter* VelocityVerletIntegrator::createDumpWriter() {
    return new DumpWriter(info_);
  }

  StatWriter* VelocityVerletIntegrator::createStatWriter() {
    
    stats = new Stats(info_);
    statWriter = new StatWriter(info_->getStatFileName(), stats);
    
    return statWriter;
  }

} //end namespace OpenMD
Revision:	1808
Committed:	Mon Oct 22 20:42:10 2012 UTC (12 years, 6 months ago) by gezelter
File size:	6783 byte(s)
Log Message:	A bug fix in the electric field for the new electrostatic code. Also comment fixes for Doxygen
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	246	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	246	* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
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	gezelter	1390	*
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, 24107 (2008).
39	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	246	*/
42
43			/**
44			* @file VelocityVerletIntegrator.cpp
45			* @author tlin
46			* @date 11/09/2004
47			* @version 1.0
48			*/
49
50			#include "integrators/VelocityVerletIntegrator.hpp"
51			#include "integrators/DLM.hpp"
52	tim	276	#include "utils/StringUtils.hpp"
53	gezelter	1413	#include "utils/ProgressBar.hpp"
54	gezelter	246
55	gezelter	1390	namespace OpenMD {
56	gezelter	1715	VelocityVerletIntegrator::VelocityVerletIntegrator(SimInfo *info) : Integrator(info) {
57	gezelter	246	dt2 = 0.5 * dt;
58	chrisfen	417	}
59
60			VelocityVerletIntegrator::~VelocityVerletIntegrator() {
61			}
62
63			void VelocityVerletIntegrator::initialize(){
64
65	gezelter	1576	forceMan_->initialize();
66	chrisfen	417
67	chrisfen	993	// remove center of mass drift velocity (in case we passed in a
68			// configuration that was drifting)
69	gezelter	246	velocitizer_->removeComDrift();
70	gezelter	1715
71			// find the initial fluctuating charges.
72			flucQ_->initialize();
73	chrisfen	417
74	gezelter	246	// initialize the forces before the first step
75	gezelter	1464	calcForce();
76	chrisfen	417
77	chrisfen	993	// execute the constraint algorithm to make sure that the system is
78			// constrained at the very beginning
79	gezelter	246	if (info_->getNGlobalConstraints() > 0) {
80	gezelter	1715	rattle_->constraintA();
81	gezelter	1464	calcForce();
82	gezelter	1715	rattle_->constraintB();
83	chrisfen	993	//copy the current snapshot to previous snapshot
84			info_->getSnapshotManager()->advance();
85	gezelter	246	}
86	chrisfen	417
87	gezelter	246	if (needVelocityScaling) {
88	chrisfen	417	velocitizer_->velocitize(targetScalingTemp);
89	gezelter	246	}
90
91			dumpWriter = createDumpWriter();
92	chrisfen	417
93	gezelter	246	statWriter = createStatWriter();
94	chrisfen	993
95			dumpWriter->writeDumpAndEor();
96
97	gezelter	1413	progressBar = new ProgressBar();
98
99	gezelter	246	//save statistics, before writeStat, we must save statistics
100			saveConservedQuantity();
101	gezelter	1764	stats->collectStats();
102
103	gezelter	1731	if (simParams->getRNEMDParameters()->getUseRNEMD())
104	skuang	1368	rnemd_->getStarted();
105	skuang	1341
106	gezelter	1764	statWriter->writeStat();
107	chrisfen	417
108	gezelter	1764	currSample = sampleTime + snap->getTime();
109			currStatus = statusTime + snap->getTime();
110			currThermal = thermalTime + snap->getTime();
111	tim	546	if (needReset) {
112	gezelter	1764	currReset = resetTime + snap->getTime();
113	tim	546	}
114	gezelter	1731	if (simParams->getRNEMDParameters()->getUseRNEMD()){
115	gezelter	1764	currRNEMD = RNEMD_exchangeTime + snap->getTime();
116	gezelter	1329	}
117	gezelter	246	needPotential = false;
118			needStress = false;
119	chrisfen	417
120	gezelter	507	}
121	gezelter	1413
122	gezelter	507	void VelocityVerletIntegrator::doIntegrate() {
123	chrisfen	417
124	gezelter	507	initialize();
125	chrisfen	417
126	gezelter	1764	while (snap->getTime() < runTime) {
127	gezelter	1715	preStep();
128			integrateStep();
129			postStep();
130			}
131	gezelter	507	finalize();
132			}
133	gezelter	246
134
135	gezelter	507	void VelocityVerletIntegrator::preStep() {
136	gezelter	1764	RealType difference = snap->getTime() + dt - currStatus;
137	chrisfen	417
138	gezelter	1390	if (difference > 0 \|\| fabs(difference) < OpenMD::epsilon) {
139	gezelter	507	needPotential = true;
140			needStress = true;
141			}
142	chrisfen	417	}
143	gezelter	246
144	gezelter	507	void VelocityVerletIntegrator::postStep() {
145	tim	749
146	gezelter	507	//save snapshot
147			info_->getSnapshotManager()->advance();
148	chrisfen	417
149	gezelter	507	//increase time
150	gezelter	1764	snap->increaseTime(dt);
151	chrisfen	993
152	gezelter	507	if (needVelocityScaling) {
153	gezelter	1764	if (snap->getTime() >= currThermal) {
154	gezelter	507	velocitizer_->velocitize(targetScalingTemp);
155			currThermal += thermalTime;
156			}
157	chrisfen	417	}
158	gezelter	1329	if (useRNEMD) {
159	gezelter	1764	if (snap->getTime() >= currRNEMD) {
160	skuang	1368	rnemd_->doRNEMD();
161			currRNEMD += RNEMD_exchangeTime;
162	gezelter	1329	}
163	gezelter	1396	rnemd_->collectData();
164	gezelter	1329	}
165
166	gezelter	1764	if (snap->getTime() >= currSample) {
167	gezelter	507	dumpWriter->writeDumpAndEor();
168	gezelter	1329
169	gezelter	507	currSample += sampleTime;
170			}
171	gezelter	1329
172	gezelter	1764	if (snap->getTime() >= currStatus) {
173	gezelter	507	//save statistics, before writeStat, we must save statistics
174	gezelter	1764	stats->collectStats();
175	gezelter	507	saveConservedQuantity();
176	skuang	1341
177	gezelter	1731	if (simParams->getRNEMDParameters()->getUseRNEMD()) {
178	gezelter	1773	rnemd_->writeOutputFile();
179	skuang	1368	}
180	skuang	1341
181	gezelter	1764	statWriter->writeStat();
182	gezelter	1413
183	gezelter	1764	progressBar->setStatus(snap->getTime(), runTime);
184	gezelter	1413	progressBar->update();
185
186	gezelter	507	needPotential = false;
187			needStress = false;
188			currStatus += statusTime;
189			}
190	gezelter	1329
191	gezelter	1764	if (needReset && snap->getTime() >= currReset) {
192	gezelter	1329	resetIntegrator();
193			currReset += resetTime;
194			}
195	gezelter	507	}
196	gezelter	246
197
198	gezelter	507	void VelocityVerletIntegrator::finalize() {
199			dumpWriter->writeEor();
200	gezelter	1776	if (simParams->getRNEMDParameters()->getUseRNEMD()) {
201			rnemd_->writeOutputFile();
202			}
203
204	gezelter	507	delete dumpWriter;
205			delete statWriter;
206	chrisfen	417
207	gezelter	507	dumpWriter = NULL;
208			statWriter = NULL;
209			}
210	gezelter	246
211	gezelter	507	void VelocityVerletIntegrator::integrateStep() {
212	chrisfen	417
213	gezelter	507	moveA();
214	gezelter	1464	calcForce();
215	gezelter	507	moveB();
216			}
217	gezelter	246
218
219	gezelter	1464	void VelocityVerletIntegrator::calcForce() {
220			forceMan_->calcForces();
221	gezelter	1718	flucQ_->applyConstraints();
222	gezelter	507	}
223	gezelter	246
224	gezelter	507	DumpWriter* VelocityVerletIntegrator::createDumpWriter() {
225			return new DumpWriter(info_);
226			}
227	gezelter	246
228	gezelter	507	StatWriter* VelocityVerletIntegrator::createStatWriter() {
229	tim	541
230	gezelter	1764	stats = new Stats(info_);
231			statWriter = new StatWriter(info_->getStatFileName(), stats);
232	skuang	1368
233	gezelter	1764	return statWriter;
234	chrisfen	417	}
235	gezelter	246
236	gezelter	1390	} //end namespace OpenMD