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]  Vardeman & Gezelter, in progress (2009).                        
 */
 
/**
 * @file VelocityVerletIntegrator.cpp
 * @author tlin
 * @date 11/09/2004
 * @time 16:16am
 * @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), rotAlgo(NULL) { 
    dt2 = 0.5 * dt;
    rotAlgo = new DLM();
    rattle = new Rattle(info);
  }
  
  VelocityVerletIntegrator::~VelocityVerletIntegrator() { 
    delete rotAlgo;
    delete rattle;
  }
  
  void VelocityVerletIntegrator::initialize(){
    
    forceMan_->init();
    
    // remove center of mass drift velocity (in case we passed in a
    // configuration that was drifting)
    velocitizer_->removeComDrift();
    
    // 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
    thermo.saveStat();
    saveConservedQuantity();
    if (simParams->getUseRNEMD())
      rnemd_->getStarted();

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


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

  void VelocityVerletIntegrator::postStep() {

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

      if (simParams->getUseRNEMD()) {
        rnemd_->getStatus();
      }

      statWriter->writeStat(currentSnapshot_->statData);

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

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


  void VelocityVerletIntegrator::finalize() {
    dumpWriter->writeEor();
  
    delete dumpWriter;
    delete statWriter;
  
    dumpWriter = NULL;
    statWriter = NULL;
  
  }

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


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

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

  StatWriter* VelocityVerletIntegrator::createStatWriter() {

    std::string statFileFormatString = simParams->getStatFileFormat();
    StatsBitSet mask = parseStatFileFormat(statFileFormatString);
   
    // if we're doing a thermodynamic integration, we'll want the raw
    // potential as well as the full potential:

 
    if (simParams->getUseThermodynamicIntegration()) 
      mask.set(Stats::VRAW);

    // if we've got restraints turned on, we'll also want a report of the
    // total harmonic restraints
    if (simParams->getUseRestraints()){
      mask.set(Stats::VHARM);
    }

    if (simParams->havePrintPressureTensor() && 
        simParams->getPrintPressureTensor()){
      mask.set(Stats::PRESSURE_TENSOR_XX);
      mask.set(Stats::PRESSURE_TENSOR_XY);
      mask.set(Stats::PRESSURE_TENSOR_XZ);
      mask.set(Stats::PRESSURE_TENSOR_YX);
      mask.set(Stats::PRESSURE_TENSOR_YY);
      mask.set(Stats::PRESSURE_TENSOR_YZ);
      mask.set(Stats::PRESSURE_TENSOR_ZX);
      mask.set(Stats::PRESSURE_TENSOR_ZY);
      mask.set(Stats::PRESSURE_TENSOR_ZZ);
    }
    
    if (simParams->getAccumulateBoxDipole()) {
      mask.set(Stats::BOX_DIPOLE_X);
      mask.set(Stats::BOX_DIPOLE_Y);
      mask.set(Stats::BOX_DIPOLE_Z);
    }
   
    if (simParams->haveTaggedAtomPair() && simParams->havePrintTaggedPairDistance()) {
      if (simParams->getPrintTaggedPairDistance()) {
        mask.set(Stats::TAGGED_PAIR_DISTANCE);
      }
    }

    if (simParams->getUseRNEMD()) {
      mask.set(Stats::RNEMD_EXCHANGE_TOTAL);
    }
    

    return new StatWriter(info_->getStatFileName(), mask);
  }


} //end namespace OpenMD
Revision:	1465
Committed:	Fri Jul 9 23:08:25 2010 UTC (14 years, 9 months ago) by chuckv
File size:	8200 byte(s)
Log Message:	Creating busticated version of OpenMD
#	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			* [4] Vardeman & Gezelter, in progress (2009).
40	gezelter	246	*/
41
42			/**
43			* @file VelocityVerletIntegrator.cpp
44			* @author tlin
45			* @date 11/09/2004
46			* @time 16:16am
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	chrisfen	417	VelocityVerletIntegrator::VelocityVerletIntegrator(SimInfo *info) : Integrator(info), rotAlgo(NULL) {
57	gezelter	246	dt2 = 0.5 * dt;
58			rotAlgo = new DLM();
59			rattle = new Rattle(info);
60	chrisfen	417	}
61
62			VelocityVerletIntegrator::~VelocityVerletIntegrator() {
63	gezelter	246	delete rotAlgo;
64			delete rattle;
65	chrisfen	417	}
66
67			void VelocityVerletIntegrator::initialize(){
68
69	gezelter	246	forceMan_->init();
70	chrisfen	417
71	chrisfen	993	// remove center of mass drift velocity (in case we passed in a
72			// configuration that was drifting)
73	gezelter	246	velocitizer_->removeComDrift();
74	chrisfen	417
75	gezelter	246	// initialize the forces before the first step
76	gezelter	1464	calcForce();
77	chrisfen	417
78	chrisfen	993	// execute the constraint algorithm to make sure that the system is
79			// constrained at the very beginning
80	gezelter	246	if (info_->getNGlobalConstraints() > 0) {
81	chrisfen	417	rattle->constraintA();
82	gezelter	1464	calcForce();
83	chrisfen	993	rattle->constraintB();
84			//copy the current snapshot to previous snapshot
85			info_->getSnapshotManager()->advance();
86	gezelter	246	}
87	chrisfen	417
88	gezelter	246	if (needVelocityScaling) {
89	chrisfen	417	velocitizer_->velocitize(targetScalingTemp);
90	gezelter	246	}
91
92			dumpWriter = createDumpWriter();
93	chrisfen	417
94	gezelter	246	statWriter = createStatWriter();
95	chrisfen	993
96			dumpWriter->writeDumpAndEor();
97
98	gezelter	1413	progressBar = new ProgressBar();
99
100	gezelter	246	//save statistics, before writeStat, we must save statistics
101			thermo.saveStat();
102			saveConservedQuantity();
103	skuang	1341	if (simParams->getUseRNEMD())
104	skuang	1368	rnemd_->getStarted();
105	skuang	1341
106	gezelter	246	statWriter->writeStat(currentSnapshot_->statData);
107	chrisfen	417
108	gezelter	246	currSample = sampleTime + currentSnapshot_->getTime();
109	gezelter	1329	currStatus = statusTime + currentSnapshot_->getTime();
110	tim	546	currThermal = thermalTime + currentSnapshot_->getTime();
111			if (needReset) {
112			currReset = resetTime + currentSnapshot_->getTime();
113			}
114	gezelter	1329	if (simParams->getUseRNEMD()){
115	skuang	1368	currRNEMD = RNEMD_exchangeTime + currentSnapshot_->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
125	gezelter	507	initialize();
126	chrisfen	417
127	gezelter	507	while (currentSnapshot_->getTime() < runTime) {
128	gezelter	246
129	gezelter	507	preStep();
130	chrisfen	417
131	gezelter	507	integrateStep();
132	chrisfen	417
133	gezelter	507	postStep();
134	gezelter	1413
135	gezelter	507	}
136	chrisfen	417
137	gezelter	507	finalize();
138	chrisfen	417
139	gezelter	507	}
140	gezelter	246
141
142	gezelter	507	void VelocityVerletIntegrator::preStep() {
143	tim	963	RealType difference = currentSnapshot_->getTime() + dt - currStatus;
144	chrisfen	417
145	gezelter	1390	if (difference > 0 \|\| fabs(difference) < OpenMD::epsilon) {
146	gezelter	507	needPotential = true;
147			needStress = true;
148			}
149	chrisfen	417	}
150	gezelter	246
151	gezelter	507	void VelocityVerletIntegrator::postStep() {
152	tim	749
153	gezelter	507	//save snapshot
154			info_->getSnapshotManager()->advance();
155	chrisfen	417
156	gezelter	507	//increase time
157			currentSnapshot_->increaseTime(dt);
158	chrisfen	993
159	gezelter	507	if (needVelocityScaling) {
160			if (currentSnapshot_->getTime() >= currThermal) {
161			velocitizer_->velocitize(targetScalingTemp);
162			currThermal += thermalTime;
163			}
164	chrisfen	417	}
165	gezelter	1329	if (useRNEMD) {
166			if (currentSnapshot_->getTime() >= currRNEMD) {
167	skuang	1368	rnemd_->doRNEMD();
168			currRNEMD += RNEMD_exchangeTime;
169	gezelter	1329	}
170	gezelter	1396	rnemd_->collectData();
171	gezelter	1329	}
172
173	gezelter	507	if (currentSnapshot_->getTime() >= currSample) {
174			dumpWriter->writeDumpAndEor();
175	gezelter	1329
176	gezelter	507	currSample += sampleTime;
177			}
178	gezelter	1329
179	gezelter	507	if (currentSnapshot_->getTime() >= currStatus) {
180			//save statistics, before writeStat, we must save statistics
181			thermo.saveStat();
182			saveConservedQuantity();
183	skuang	1341
184	skuang	1368	if (simParams->getUseRNEMD()) {
185	skuang	1338	rnemd_->getStatus();
186	skuang	1368	}
187	skuang	1341
188			statWriter->writeStat(currentSnapshot_->statData);
189	gezelter	1413
190			progressBar->setStatus(currentSnapshot_->getTime(), runTime);
191			progressBar->update();
192
193	gezelter	507	needPotential = false;
194			needStress = false;
195			currStatus += statusTime;
196			}
197	gezelter	1329
198			if (needReset && currentSnapshot_->getTime() >= currReset) {
199			resetIntegrator();
200			currReset += resetTime;
201			}
202	gezelter	507	}
203	gezelter	246
204
205	gezelter	507	void VelocityVerletIntegrator::finalize() {
206			dumpWriter->writeEor();
207	chrisfen	417
208	gezelter	507	delete dumpWriter;
209			delete statWriter;
210	chrisfen	417
211	gezelter	507	dumpWriter = NULL;
212			statWriter = NULL;
213	chrisfen	417
214	gezelter	507	}
215	gezelter	246
216	gezelter	507	void VelocityVerletIntegrator::integrateStep() {
217	chrisfen	417
218	gezelter	507	moveA();
219	gezelter	1464	calcForce();
220	gezelter	507	moveB();
221			}
222	gezelter	246
223
224	gezelter	1464	void VelocityVerletIntegrator::calcForce() {
225			forceMan_->calcForces();
226	gezelter	507	}
227	gezelter	246
228	gezelter	507	DumpWriter* VelocityVerletIntegrator::createDumpWriter() {
229			return new DumpWriter(info_);
230			}
231	gezelter	246
232	gezelter	507	StatWriter* VelocityVerletIntegrator::createStatWriter() {
233	tim	681
234			std::string statFileFormatString = simParams->getStatFileFormat();
235			StatsBitSet mask = parseStatFileFormat(statFileFormatString);
236	cli2	1360
237			// if we're doing a thermodynamic integration, we'll want the raw
238			// potential as well as the full potential:
239
240
241			if (simParams->getUseThermodynamicIntegration())
242	gezelter	507	mask.set(Stats::VRAW);
243	cli2	1360
244			// if we've got restraints turned on, we'll also want a report of the
245			// total harmonic restraints
246			if (simParams->getUseRestraints()){
247	gezelter	507	mask.set(Stats::VHARM);
248			}
249	tim	541
250	chrisfen	993	if (simParams->havePrintPressureTensor() &&
251			simParams->getPrintPressureTensor()){
252	gezelter	1291	mask.set(Stats::PRESSURE_TENSOR_XX);
253			mask.set(Stats::PRESSURE_TENSOR_XY);
254			mask.set(Stats::PRESSURE_TENSOR_XZ);
255			mask.set(Stats::PRESSURE_TENSOR_YX);
256			mask.set(Stats::PRESSURE_TENSOR_YY);
257			mask.set(Stats::PRESSURE_TENSOR_YZ);
258			mask.set(Stats::PRESSURE_TENSOR_ZX);
259			mask.set(Stats::PRESSURE_TENSOR_ZY);
260			mask.set(Stats::PRESSURE_TENSOR_ZZ);
261	tim	541	}
262
263	chrisfen	998	if (simParams->getAccumulateBoxDipole()) {
264			mask.set(Stats::BOX_DIPOLE_X);
265			mask.set(Stats::BOX_DIPOLE_Y);
266			mask.set(Stats::BOX_DIPOLE_Z);
267			}
268	gezelter	1329
269	gezelter	1291	if (simParams->haveTaggedAtomPair() && simParams->havePrintTaggedPairDistance()) {
270			if (simParams->getPrintTaggedPairDistance()) {
271			mask.set(Stats::TAGGED_PAIR_DISTANCE);
272			}
273			}
274	gezelter	1329
275			if (simParams->getUseRNEMD()) {
276	skuang	1368	mask.set(Stats::RNEMD_EXCHANGE_TOTAL);
277	gezelter	1329	}
278	skuang	1368
279	chrisfen	998
280	skuang	1368	return new StatWriter(info_->getStatFileName(), mask);
281	chrisfen	417	}
282	gezelter	246
283
284	gezelter	1390	} //end namespace OpenMD