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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */
 
/**
 * @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"

namespace oopse {
  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(true, true);
    
    // execute the constraint algorithm to make sure that the system is
    // constrained at the very beginning  
    if (info_->getNGlobalConstraints() > 0) {
      rattle->constraintA();
      calcForce(true, true);
      rattle->constraintB();      
      //copy the current snapshot to previous snapshot
      info_->getSnapshotManager()->advance();
    }
    
    if (needVelocityScaling) {
      velocitizer_->velocitize(targetScalingTemp);
    }
    
    dumpWriter = createDumpWriter();
    
    statWriter = createStatWriter();
 
    dumpWriter->writeDumpAndEor();

    if (simParams->getUseSolidThermInt()) {
      restWriter = createRestWriter();
      restWriter->writeZAngFile();
    }
    
    //save statistics, before writeStat,  we must save statistics
    thermo.saveStat();
    saveConservedQuantity();
    statWriter->writeStat(currentSnapshot_->statData);
    
    currSample = sampleTime + currentSnapshot_->getTime();
    currStatus =  statusTime + currentSnapshot_->getTime();;
    currThermal = thermalTime + currentSnapshot_->getTime();
    if (needReset) {
      currReset = resetTime + 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) < oopse::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 (currentSnapshot_->getTime() >= currSample) {
      dumpWriter->writeDumpAndEor();

      if (simParams->getUseSolidThermInt())
        restWriter->writeZAngFile();
    
      currSample += sampleTime;
    }

    if (currentSnapshot_->getTime() >= currStatus) {
      //save statistics, before writeStat,  we must save statistics
      thermo.saveStat();
      saveConservedQuantity();
      statWriter->writeStat(currentSnapshot_->statData);
    
      needPotential = false;
      needStress = false;
      currStatus += statusTime;
    }

      if (needReset && currentSnapshot_->getTime() >= currReset) {    
        resetIntegrator();
        currReset += resetTime;
      }
  
  }


  void VelocityVerletIntegrator::finalize() {
    dumpWriter->writeEor();
  
    if (simParams->getUseSolidThermInt()) {
      restWriter->writeZAngFile();
      delete restWriter;
      restWriter = NULL;
    }
  
    delete dumpWriter;
    delete statWriter;
  
    dumpWriter = NULL;
    statWriter = NULL;
  
  }

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


  void VelocityVerletIntegrator::calcForce(bool needPotential,
                                           bool needStress) { 
    forceMan_->calcForces(needPotential, needStress);
  }

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

  StatWriter* VelocityVerletIntegrator::createStatWriter() {

    std::string statFileFormatString = simParams->getStatFileFormat();
    StatsBitSet mask = parseStatFileFormat(statFileFormatString);
    
    // if solidThermInt is true, add extra information to the statfile
    if (simParams->getUseSolidThermInt()){
      mask.set(Stats::VRAW);
      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);
      }
    }
      

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

  RestWriter* VelocityVerletIntegrator::createRestWriter(){
    return new RestWriter(info_);
  }


} //end namespace oopse
Revision:	1291
Committed:	Thu Sep 11 19:40:59 2008 UTC (16 years, 7 months ago) by gezelter
File size:	7827 byte(s)
Log Message:	Added some logic to print out a special pair distance as a column in the stat file. To use this feature, use taggedAtomPair = "0, 10" and printTaggedPairDistance = "true" in the md file. Then, the distance between integrableObjects 0 and 10 will be computed and printed in the stat file on each statWrite.
#	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. Acknowledgement of the program authors must be made in any
10	* publication of scientific results based in part on use of the
11	* program. An acceptable form of acknowledgement is citation of
12	* the article in which the program was described (Matthew
13	* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14	* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15	* Parallel Simulation Engine for Molecular Dynamics,"
16	* J. Comput. Chem. 26, pp. 252-271 (2005))
17	*
18	* 2. Redistributions of source code must retain the above copyright
19	* notice, this list of conditions and the following disclaimer.
20	*
21	* 3. Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the
24	* distribution.
25	*
26	* This software is provided "AS IS," without a warranty of any
27	* kind. All express or implied conditions, representations and
28	* warranties, including any implied warranty of merchantability,
29	* fitness for a particular purpose or non-infringement, are hereby
30	* excluded. The University of Notre Dame and its licensors shall not
31	* be liable for any damages suffered by licensee as a result of
32	* using, modifying or distributing the software or its
33	* derivatives. In no event will the University of Notre Dame or its
34	* licensors be liable for any lost revenue, profit or data, or for
35	* direct, indirect, special, consequential, incidental or punitive
36	* damages, however caused and regardless of the theory of liability,
37	* arising out of the use of or inability to use software, even if the
38	* University of Notre Dame has been advised of the possibility of
39	* such damages.
40	*/
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	#include "utils/StringUtils.hpp"
53
54	namespace oopse {
55	VelocityVerletIntegrator::VelocityVerletIntegrator(SimInfo *info) : Integrator(info), rotAlgo(NULL) {
56	dt2 = 0.5 * dt;
57	rotAlgo = new DLM();
58	rattle = new Rattle(info);
59	}
60
61	VelocityVerletIntegrator::~VelocityVerletIntegrator() {
62	delete rotAlgo;
63	delete rattle;
64	}
65
66	void VelocityVerletIntegrator::initialize(){
67
68	forceMan_->init();
69
70	// remove center of mass drift velocity (in case we passed in a
71	// configuration that was drifting)
72	velocitizer_->removeComDrift();
73
74	// initialize the forces before the first step
75	calcForce(true, true);
76
77	// execute the constraint algorithm to make sure that the system is
78	// constrained at the very beginning
79	if (info_->getNGlobalConstraints() > 0) {
80	rattle->constraintA();
81	calcForce(true, true);
82	rattle->constraintB();
83	//copy the current snapshot to previous snapshot
84	info_->getSnapshotManager()->advance();
85	}
86
87	if (needVelocityScaling) {
88	velocitizer_->velocitize(targetScalingTemp);
89	}
90
91	dumpWriter = createDumpWriter();
92
93	statWriter = createStatWriter();
94
95	dumpWriter->writeDumpAndEor();
96
97	if (simParams->getUseSolidThermInt()) {
98	restWriter = createRestWriter();
99	restWriter->writeZAngFile();
100	}
101
102	//save statistics, before writeStat, we must save statistics
103	thermo.saveStat();
104	saveConservedQuantity();
105	statWriter->writeStat(currentSnapshot_->statData);
106
107	currSample = sampleTime + currentSnapshot_->getTime();
108	currStatus = statusTime + currentSnapshot_->getTime();;
109	currThermal = thermalTime + currentSnapshot_->getTime();
110	if (needReset) {
111	currReset = resetTime + currentSnapshot_->getTime();
112	}
113	needPotential = false;
114	needStress = false;
115
116	}
117
118	void VelocityVerletIntegrator::doIntegrate() {
119
120
121	initialize();
122
123	while (currentSnapshot_->getTime() < runTime) {
124
125	preStep();
126
127	integrateStep();
128
129	postStep();
130
131	}
132
133	finalize();
134
135	}
136
137
138	void VelocityVerletIntegrator::preStep() {
139	RealType difference = currentSnapshot_->getTime() + dt - currStatus;
140
141	if (difference > 0 \|\| fabs(difference) < oopse::epsilon) {
142	needPotential = true;
143	needStress = true;
144	}
145	}
146
147	void VelocityVerletIntegrator::postStep() {
148
149	//save snapshot
150	info_->getSnapshotManager()->advance();
151
152	//increase time
153	currentSnapshot_->increaseTime(dt);
154
155	if (needVelocityScaling) {
156	if (currentSnapshot_->getTime() >= currThermal) {
157	velocitizer_->velocitize(targetScalingTemp);
158	currThermal += thermalTime;
159	}
160	}
161
162	if (currentSnapshot_->getTime() >= currSample) {
163	dumpWriter->writeDumpAndEor();
164
165	if (simParams->getUseSolidThermInt())
166	restWriter->writeZAngFile();
167
168	currSample += sampleTime;
169	}
170
171	if (currentSnapshot_->getTime() >= currStatus) {
172	//save statistics, before writeStat, we must save statistics
173	thermo.saveStat();
174	saveConservedQuantity();
175	statWriter->writeStat(currentSnapshot_->statData);
176
177	needPotential = false;
178	needStress = false;
179	currStatus += statusTime;
180	}
181
182	if (needReset && currentSnapshot_->getTime() >= currReset) {
183	resetIntegrator();
184	currReset += resetTime;
185	}
186
187	}
188
189
190	void VelocityVerletIntegrator::finalize() {
191	dumpWriter->writeEor();
192
193	if (simParams->getUseSolidThermInt()) {
194	restWriter->writeZAngFile();
195	delete restWriter;
196	restWriter = NULL;
197	}
198
199	delete dumpWriter;
200	delete statWriter;
201
202	dumpWriter = NULL;
203	statWriter = NULL;
204
205	}
206
207	void VelocityVerletIntegrator::integrateStep() {
208
209	moveA();
210	calcForce(needPotential, needStress);
211	moveB();
212	}
213
214
215	void VelocityVerletIntegrator::calcForce(bool needPotential,
216	bool needStress) {
217	forceMan_->calcForces(needPotential, needStress);
218	}
219
220	DumpWriter* VelocityVerletIntegrator::createDumpWriter() {
221	return new DumpWriter(info_);
222	}
223
224	StatWriter* VelocityVerletIntegrator::createStatWriter() {
225
226	std::string statFileFormatString = simParams->getStatFileFormat();
227	StatsBitSet mask = parseStatFileFormat(statFileFormatString);
228
229	// if solidThermInt is true, add extra information to the statfile
230	if (simParams->getUseSolidThermInt()){
231	mask.set(Stats::VRAW);
232	mask.set(Stats::VHARM);
233	}
234
235	if (simParams->havePrintPressureTensor() &&
236	simParams->getPrintPressureTensor()){
237	mask.set(Stats::PRESSURE_TENSOR_XX);
238	mask.set(Stats::PRESSURE_TENSOR_XY);
239	mask.set(Stats::PRESSURE_TENSOR_XZ);
240	mask.set(Stats::PRESSURE_TENSOR_YX);
241	mask.set(Stats::PRESSURE_TENSOR_YY);
242	mask.set(Stats::PRESSURE_TENSOR_YZ);
243	mask.set(Stats::PRESSURE_TENSOR_ZX);
244	mask.set(Stats::PRESSURE_TENSOR_ZY);
245	mask.set(Stats::PRESSURE_TENSOR_ZZ);
246	}
247
248	if (simParams->getAccumulateBoxDipole()) {
249	mask.set(Stats::BOX_DIPOLE_X);
250	mask.set(Stats::BOX_DIPOLE_Y);
251	mask.set(Stats::BOX_DIPOLE_Z);
252	}
253
254	if (simParams->haveTaggedAtomPair() && simParams->havePrintTaggedPairDistance()) {
255	if (simParams->getPrintTaggedPairDistance()) {
256	mask.set(Stats::TAGGED_PAIR_DISTANCE);
257	}
258	}
259
260
261	return new StatWriter(info_->getStatFileName(), mask);
262	}
263
264	RestWriter* VelocityVerletIntegrator::createRestWriter(){
265	return new RestWriter(info_);
266	}
267
268
269	} //end namespace oopse