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