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_X);
        mask.set(Stats::PRESSURE_TENSOR_Y);
        mask.set(Stats::PRESSURE_TENSOR_Z);
    }
    
    if (simParams->getAccumulateBoxDipole()) {
      mask.set(Stats::BOX_DIPOLE_X);
      mask.set(Stats::BOX_DIPOLE_Y);
      mask.set(Stats::BOX_DIPOLE_Z);
    }

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

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


} //end namespace oopse
Revision:	998
Committed:	Mon Jul 3 13:18:43 2006 UTC (19 years, 4 months ago) by chrisfen
File size:	7362 byte(s)
Log Message:	Added simulation box dipole moment accumulation for the purposes of calculating dielectric constants
#	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			* 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	tim	276	#include "utils/StringUtils.hpp"
53	gezelter	246
54			namespace oopse {
55	chrisfen	417	VelocityVerletIntegrator::VelocityVerletIntegrator(SimInfo *info) : Integrator(info), rotAlgo(NULL) {
56	gezelter	246	dt2 = 0.5 * dt;
57			rotAlgo = new DLM();
58			rattle = new Rattle(info);
59	chrisfen	417	}
60
61			VelocityVerletIntegrator::~VelocityVerletIntegrator() {
62	gezelter	246	delete rotAlgo;
63			delete rattle;
64	chrisfen	417	}
65
66			void VelocityVerletIntegrator::initialize(){
67
68	gezelter	246	forceMan_->init();
69	chrisfen	417
70	chrisfen	993	// remove center of mass drift velocity (in case we passed in a
71			// configuration that was drifting)
72	gezelter	246	velocitizer_->removeComDrift();
73	chrisfen	417
74	gezelter	246	// initialize the forces before the first step
75			calcForce(true, true);
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	chrisfen	417	rattle->constraintA();
81			calcForce(true, true);
82	chrisfen	993	rattle->constraintB();
83			//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	chrisfen	417	if (simParams->getUseSolidThermInt()) {
98			restWriter = createRestWriter();
99	chrisfen	993	restWriter->writeZAngFile();
100	chrisfen	417	}
101
102	gezelter	246	//save statistics, before writeStat, we must save statistics
103			thermo.saveStat();
104			saveConservedQuantity();
105			statWriter->writeStat(currentSnapshot_->statData);
106	chrisfen	417
107	gezelter	246	currSample = sampleTime + currentSnapshot_->getTime();
108			currStatus = statusTime + currentSnapshot_->getTime();;
109	tim	546	currThermal = thermalTime + currentSnapshot_->getTime();
110			if (needReset) {
111			currReset = resetTime + currentSnapshot_->getTime();
112			}
113	gezelter	246	needPotential = false;
114			needStress = false;
115	chrisfen	417
116	gezelter	507	}
117	chrisfen	417
118	gezelter	507	void VelocityVerletIntegrator::doIntegrate() {
119	chrisfen	417
120
121	gezelter	507	initialize();
122	chrisfen	417
123	gezelter	507	while (currentSnapshot_->getTime() < runTime) {
124	gezelter	246
125	gezelter	507	preStep();
126	chrisfen	417
127	gezelter	507	integrateStep();
128	chrisfen	417
129	gezelter	507	postStep();
130	chrisfen	417
131	gezelter	507	}
132	chrisfen	417
133	gezelter	507	finalize();
134	chrisfen	417
135	gezelter	507	}
136	gezelter	246
137
138	gezelter	507	void VelocityVerletIntegrator::preStep() {
139	tim	963	RealType difference = currentSnapshot_->getTime() + dt - currStatus;
140	chrisfen	417
141	gezelter	507	if (difference > 0 \|\| fabs(difference) < oopse::epsilon) {
142			needPotential = true;
143			needStress = true;
144			}
145	chrisfen	417	}
146	gezelter	246
147	gezelter	507	void VelocityVerletIntegrator::postStep() {
148	tim	749
149	gezelter	507	//save snapshot
150			info_->getSnapshotManager()->advance();
151	chrisfen	417
152	gezelter	507	//increase time
153			currentSnapshot_->increaseTime(dt);
154	chrisfen	993
155	gezelter	507	if (needVelocityScaling) {
156			if (currentSnapshot_->getTime() >= currThermal) {
157			velocitizer_->velocitize(targetScalingTemp);
158			currThermal += thermalTime;
159			}
160	chrisfen	417	}
161	chrisfen	993
162	gezelter	507	if (currentSnapshot_->getTime() >= currSample) {
163			dumpWriter->writeDumpAndEor();
164	chrisfen	993
165	gezelter	507	if (simParams->getUseSolidThermInt())
166	chrisfen	993	restWriter->writeZAngFile();
167	chrisfen	417
168	gezelter	507	currSample += sampleTime;
169			}
170	chrisfen	993
171	gezelter	507	if (currentSnapshot_->getTime() >= currStatus) {
172			//save statistics, before writeStat, we must save statistics
173			thermo.saveStat();
174			saveConservedQuantity();
175			statWriter->writeStat(currentSnapshot_->statData);
176	chrisfen	417
177	gezelter	507	needPotential = false;
178			needStress = false;
179			currStatus += statusTime;
180			}
181	tim	546
182			if (needReset && currentSnapshot_->getTime() >= currReset) {
183			resetIntegrator();
184			currReset += resetTime;
185			}
186	chrisfen	417
187	gezelter	507	}
188	gezelter	246
189
190	gezelter	507	void VelocityVerletIntegrator::finalize() {
191			dumpWriter->writeEor();
192	chrisfen	417
193	gezelter	507	if (simParams->getUseSolidThermInt()) {
194	chrisfen	993	// restWriter->writeZAngFile();
195	gezelter	507	delete restWriter;
196			restWriter = NULL;
197			}
198	chrisfen	417
199	gezelter	507	delete dumpWriter;
200			delete statWriter;
201	chrisfen	417
202	gezelter	507	dumpWriter = NULL;
203			statWriter = NULL;
204	chrisfen	417
205	gezelter	507	}
206	gezelter	246
207	gezelter	507	void VelocityVerletIntegrator::integrateStep() {
208	chrisfen	417
209	gezelter	507	moveA();
210			calcForce(needPotential, needStress);
211			moveB();
212			}
213	gezelter	246
214
215	gezelter	507	void VelocityVerletIntegrator::calcForce(bool needPotential,
216			bool needStress) {
217			forceMan_->calcForces(needPotential, needStress);
218			}
219	gezelter	246
220	gezelter	507	DumpWriter* VelocityVerletIntegrator::createDumpWriter() {
221			return new DumpWriter(info_);
222			}
223	gezelter	246
224	gezelter	507	StatWriter* VelocityVerletIntegrator::createStatWriter() {
225	tim	681
226			std::string statFileFormatString = simParams->getStatFileFormat();
227			StatsBitSet mask = parseStatFileFormat(statFileFormatString);
228
229	gezelter	507	// 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	tim	541
235	chrisfen	993	if (simParams->havePrintPressureTensor() &&
236			simParams->getPrintPressureTensor()){
237	tim	541	mask.set(Stats::PRESSURE_TENSOR_X);
238			mask.set(Stats::PRESSURE_TENSOR_Y);
239			mask.set(Stats::PRESSURE_TENSOR_Z);
240			}
241
242	chrisfen	998	if (simParams->getAccumulateBoxDipole()) {
243			mask.set(Stats::BOX_DIPOLE_X);
244			mask.set(Stats::BOX_DIPOLE_Y);
245			mask.set(Stats::BOX_DIPOLE_Z);
246			}
247
248	tim	681	return new StatWriter(info_->getStatFileName(), mask);
249	chrisfen	417	}
250	gezelter	246
251	gezelter	507	RestWriter* VelocityVerletIntegrator::createRestWriter(){
252			return new RestWriter(info_);
253			}
254	gezelter	246
255	chrisfen	417
256	gezelter	246	} //end namespace oopse