OOPSE/libmdtools/NPT.cpp

#include <stdlib.h>
#include <math.h>

#include "Atom.hpp"
#include "SRI.hpp"
#include "AbstractClasses.hpp"
#include "SimInfo.hpp"
#include "ForceFields.hpp"
#include "Thermo.hpp"
#include "ReadWrite.hpp"
#include "Integrator.hpp"
#include "simError.h"

#ifdef IS_MPI
#include "mpiSimulation.hpp"
#endif


// Basic isotropic thermostating and barostating via the Melchionna
// modification of the Hoover algorithm:
//
//    Melchionna, S., Ciccotti, G., and Holian, B. L., 1993,
//       Molec. Phys., 78, 533.
//
//           and
//
//    Hoover, W. G., 1986, Phys. Rev. A, 34, 2499.

NPT::NPT ( SimInfo *theInfo, ForceFields* the_ff):
  Integrator( theInfo, the_ff )
{
  GenericData* data;
  
  chi = 0.0;
  integralOfChidt = 0.0;
  have_tau_thermostat = 0;
  have_tau_barostat = 0;
  have_target_temp = 0;
  have_target_pressure = 0;
  have_chi_tolerance = 0;
  have_eta_tolerance = 0;
  have_pos_iter_tolerance = 0;

  // retrieve chi and integralOfChidt from simInfo
  data = info->getProperty(CHIVALUE_ID);
  if(data != NULL ){
    chi = data->getDval();
  }

  data = info->getProperty(INTEGRALOFCHIDT_ID);
  if(data != NULL ){
    integralOfChidt = data->getDval();
  }

  oldPos = new double[3*nAtoms];
  oldVel = new double[3*nAtoms];
  oldJi = new double[3*nAtoms];
#ifdef IS_MPI
  Nparticles = mpiSim->getTotAtoms();
#else
  Nparticles = theInfo->n_atoms;
#endif

}

NPT::~NPT() {
  delete[] oldPos;
  delete[] oldVel;
  delete[] oldJi;
}

void NPT::moveA() {

  //new version of NPT
  int i, j, k;
  DirectionalAtom* dAtom;
  double Tb[3], ji[3];
  double mass;
  double vel[3], pos[3], frc[3];
  double sc[3];
  double COM[3];

  instaTemp = tStats->getTemperature();
  tStats->getPressureTensor( press );
  instaPress = p_convert * (press[0][0] + press[1][1] + press[2][2]) / 3.0;
  instaVol = tStats->getVolume();

  tStats->getCOM(COM);

  //evolve velocity half step
  for( i=0; i<nAtoms; i++ ){

    atoms[i]->getVel( vel );
    atoms[i]->getFrc( frc );

    mass = atoms[i]->getMass();

    getVelScaleA( sc, vel );

    for (j=0; j < 3; j++) {

      // velocity half step  (use chi from previous step here):
      vel[j] += dt2 * ((frc[j] / mass ) * eConvert - sc[j]);

    }

    atoms[i]->setVel( vel );

    if( atoms[i]->isDirectional() ){

      dAtom = (DirectionalAtom *)atoms[i];

      // get and convert the torque to body frame

      dAtom->getTrq( Tb );
      dAtom->lab2Body( Tb );

      // get the angular momentum, and propagate a half step

      dAtom->getJ( ji );

      for (j=0; j < 3; j++)
        ji[j] += dt2 * (Tb[j] * eConvert - ji[j]*chi);

      this->rotationPropagation( dAtom, ji );

      dAtom->setJ( ji );
    }
  }

  // evolve chi and eta  half step

  evolveChiA();
  evolveEtaA();

  //calculate the integral of chidt
  integralOfChidt += dt2*chi;

  //save the old positions
  for(i = 0; i < nAtoms; i++){
    atoms[i]->getPos(pos);
    for(j = 0; j < 3; j++)
      oldPos[i*3 + j] = pos[j];
  }

  //the first estimation of r(t+dt) is equal to  r(t)

  for(k = 0; k < 5; k ++){

    for(i =0 ; i < nAtoms; i++){

      atoms[i]->getVel(vel);
      atoms[i]->getPos(pos);

      this->getPosScale( pos, COM, i, sc );

      for(j = 0; j < 3; j++)
        pos[j] = oldPos[i*3 + j] + dt*(vel[j] + sc[j]);

      atoms[i]->setPos( pos );
    }

    if (nConstrained){
      constrainA();
    }
  }


  // Scale the box after all the positions have been moved:

  this->scaleSimBox();
}

void NPT::moveB( void ){

  //new version of NPT
  int i, j, k;
  DirectionalAtom* dAtom;
  double Tb[3], ji[3], sc[3];
  double vel[3], frc[3];
  double mass;

  // Set things up for the iteration:

  for( i=0; i<nAtoms; i++ ){

    atoms[i]->getVel( vel );

    for (j=0; j < 3; j++)
      oldVel[3*i + j]  = vel[j];

    if( atoms[i]->isDirectional() ){

      dAtom = (DirectionalAtom *)atoms[i];

      dAtom->getJ( ji );

      for (j=0; j < 3; j++)
        oldJi[3*i + j] = ji[j];

    }
  }

  // do the iteration:

  instaVol = tStats->getVolume();

  for (k=0; k < 4; k++) {

    instaTemp = tStats->getTemperature();
    instaPress = tStats->getPressure();

    // evolve chi another half step using the temperature at t + dt/2

    this->evolveChiB();
    this->evolveEtaB();

    for( i=0; i<nAtoms; i++ ){

      atoms[i]->getFrc( frc );
      atoms[i]->getVel(vel);

      mass = atoms[i]->getMass();

      getVelScaleB( sc, i );

      // velocity half step
      for (j=0; j < 3; j++)
        vel[j] = oldVel[3*i+j] + dt2 * ((frc[j] / mass ) * eConvert - sc[j]);

      atoms[i]->setVel( vel );

      if( atoms[i]->isDirectional() ){

        dAtom = (DirectionalAtom *)atoms[i];

        // get and convert the torque to body frame

        dAtom->getTrq( Tb );
        dAtom->lab2Body( Tb );

        for (j=0; j < 3; j++)
          ji[j] = oldJi[3*i + j] + dt2 * (Tb[j] * eConvert - oldJi[3*i+j]*chi);

          dAtom->setJ( ji );
      }
    }

    if (nConstrained){
      constrainB();
    }

    if ( this->chiConverged() && this->etaConverged() ) break;
  }

  //calculate integral of chida
  integralOfChidt += dt2*chi;


}

void NPT::resetIntegrator() {
  chi = 0.0;
  Integrator::resetIntegrator();
}

void NPT::evolveChiA() {
  chi += dt2 * ( instaTemp / targetTemp - 1.0) / tt2;
  oldChi = chi;
}

void NPT::evolveChiB() {

  prevChi = chi;
  chi = oldChi + dt2 * ( instaTemp / targetTemp - 1.0) / tt2;
}

bool NPT::chiConverged() {

  return ( fabs( prevChi - chi ) <= chiTolerance );
}

int NPT::readyCheck() {

  //check parent's readyCheck() first
  if (Integrator::readyCheck() == -1)
    return -1;

  // First check to see if we have a target temperature.
  // Not having one is fatal.

  if (!have_target_temp) {
    sprintf( painCave.errMsg,
             "NPT error: You can't use the NPT integrator\n"
             "   without a targetTemp!\n"
             );
    painCave.isFatal = 1;
    simError();
    return -1;
  }

  if (!have_target_pressure) {
    sprintf( painCave.errMsg,
             "NPT error: You can't use the NPT integrator\n"
             "   without a targetPressure!\n"
             );
    painCave.isFatal = 1;
    simError();
    return -1;
  }

  // We must set tauThermostat.

  if (!have_tau_thermostat) {
    sprintf( painCave.errMsg,
             "NPT error: If you use the NPT\n"
             "   integrator, you must set tauThermostat.\n");
    painCave.isFatal = 1;
    simError();
    return -1;
  }

  // We must set tauBarostat.

  if (!have_tau_barostat) {
    sprintf( painCave.errMsg,
             "NPT error: If you use the NPT\n"
             "   integrator, you must set tauBarostat.\n");
    painCave.isFatal = 1;
    simError();
    return -1;
  }

  if (!have_chi_tolerance) {
    sprintf( painCave.errMsg,
             "NPT warning: setting chi tolerance to 1e-6\n");
    chiTolerance = 1e-6;
    have_chi_tolerance = 1;
    painCave.isFatal = 0;
    simError();
  }

  if (!have_eta_tolerance) {
    sprintf( painCave.errMsg,
             "NPT warning: setting eta tolerance to 1e-6\n");
    etaTolerance = 1e-6;
    have_eta_tolerance = 1;
    painCave.isFatal = 0;
    simError();
  }

  // We need NkBT a lot, so just set it here: This is the RAW number
  // of particles, so no subtraction or addition of constraints or
  // orientational degrees of freedom:

  NkBT = (double)Nparticles * kB * targetTemp;

  // fkBT is used because the thermostat operates on more degrees of freedom
  // than the barostat (when there are particles with orientational degrees
  // of freedom).  ndf = 3 * (n_atoms + n_oriented -1) - n_constraint - nZcons

  fkBT = (double)info->ndf * kB * targetTemp;

  tt2 = tauThermostat * tauThermostat;
  tb2 = tauBarostat * tauBarostat;

  return 1;
}
Revision:	850
Committed:	Mon Nov 3 22:07:17 2003 UTC (21 years, 8 months ago) by mmeineke
File size:	7715 byte(s)
Log Message:	begun work on removing templates and most of standard template library from OOPSE.
#	User	Rev	Content
1	mmeineke	850	#include <stdlib.h>
2	gezelter	829	#include <math.h>
3	mmeineke	850
4	mmeineke	778	#include "Atom.hpp"
5			#include "SRI.hpp"
6			#include "AbstractClasses.hpp"
7			#include "SimInfo.hpp"
8			#include "ForceFields.hpp"
9			#include "Thermo.hpp"
10			#include "ReadWrite.hpp"
11			#include "Integrator.hpp"
12	tim	837	#include "simError.h"
13	mmeineke	778
14			#ifdef IS_MPI
15			#include "mpiSimulation.hpp"
16			#endif
17
18
19			// Basic isotropic thermostating and barostating via the Melchionna
20			// modification of the Hoover algorithm:
21			//
22			// Melchionna, S., Ciccotti, G., and Holian, B. L., 1993,
23	tim	837	// Molec. Phys., 78, 533.
24	mmeineke	778	//
25			// and
26	tim	837	//
27	mmeineke	778	// Hoover, W. G., 1986, Phys. Rev. A, 34, 2499.
28
29	mmeineke	849	NPT::NPT ( SimInfo theInfo, ForceFields the_ff):
30			Integrator( theInfo, the_ff )
31	mmeineke	778	{
32	tim	837	GenericData* data;
33	mmeineke	849
34	mmeineke	778	chi = 0.0;
35			integralOfChidt = 0.0;
36			have_tau_thermostat = 0;
37			have_tau_barostat = 0;
38			have_target_temp = 0;
39			have_target_pressure = 0;
40			have_chi_tolerance = 0;
41			have_eta_tolerance = 0;
42			have_pos_iter_tolerance = 0;
43
44	tim	837	// retrieve chi and integralOfChidt from simInfo
45			data = info->getProperty(CHIVALUE_ID);
46	mmeineke	850	if(data != NULL ){
47			chi = data->getDval();
48	tim	837	}
49
50			data = info->getProperty(INTEGRALOFCHIDT_ID);
51	mmeineke	850	if(data != NULL ){
52			integralOfChidt = data->getDval();
53	tim	837	}
54
55	mmeineke	778	oldPos = new double[3*nAtoms];
56			oldVel = new double[3*nAtoms];
57			oldJi = new double[3*nAtoms];
58			#ifdef IS_MPI
59			Nparticles = mpiSim->getTotAtoms();
60			#else
61			Nparticles = theInfo->n_atoms;
62			#endif
63
64			}
65
66	mmeineke	849	NPT::~NPT() {
67	mmeineke	778	delete[] oldPos;
68			delete[] oldVel;
69			delete[] oldJi;
70			}
71
72	mmeineke	849	void NPT::moveA() {
73	tim	837
74	mmeineke	778	//new version of NPT
75			int i, j, k;
76			DirectionalAtom* dAtom;
77			double Tb[3], ji[3];
78			double mass;
79			double vel[3], pos[3], frc[3];
80			double sc[3];
81			double COM[3];
82
83			instaTemp = tStats->getTemperature();
84	mmeineke	780	tStats->getPressureTensor( press );
85			instaPress = p_convert * (press[0][0] + press[1][1] + press[2][2]) / 3.0;
86	mmeineke	778	instaVol = tStats->getVolume();
87	tim	837
88	mmeineke	778	tStats->getCOM(COM);
89	tim	837
90	mmeineke	778	//evolve velocity half step
91			for( i=0; i<nAtoms; i++ ){
92
93			atoms[i]->getVel( vel );
94			atoms[i]->getFrc( frc );
95
96			mass = atoms[i]->getMass();
97
98			getVelScaleA( sc, vel );
99
100			for (j=0; j < 3; j++) {
101	tim	837
102	mmeineke	778	// velocity half step (use chi from previous step here):
103			vel[j] += dt2 * ((frc[j] / mass ) * eConvert - sc[j]);
104	tim	837
105	mmeineke	778	}
106
107			atoms[i]->setVel( vel );
108	tim	837
109	mmeineke	778	if( atoms[i]->isDirectional() ){
110
111			dAtom = (DirectionalAtom *)atoms[i];
112
113			// get and convert the torque to body frame
114	tim	837
115	mmeineke	778	dAtom->getTrq( Tb );
116			dAtom->lab2Body( Tb );
117	tim	837
118	mmeineke	778	// get the angular momentum, and propagate a half step
119
120			dAtom->getJ( ji );
121
122	tim	837	for (j=0; j < 3; j++)
123	mmeineke	778	ji[j] += dt2 * (Tb[j] * eConvert - ji[j]*chi);
124	tim	837
125	mmeineke	778	this->rotationPropagation( dAtom, ji );
126	tim	837
127	mmeineke	778	dAtom->setJ( ji );
128	tim	837	}
129	mmeineke	778	}
130
131			// evolve chi and eta half step
132	tim	837
133	mmeineke	778	evolveChiA();
134			evolveEtaA();
135
136			//calculate the integral of chidt
137			integralOfChidt += dt2*chi;
138
139			//save the old positions
140			for(i = 0; i < nAtoms; i++){
141			atoms[i]->getPos(pos);
142			for(j = 0; j < 3; j++)
143			oldPos[i*3 + j] = pos[j];
144			}
145	tim	837
146			//the first estimation of r(t+dt) is equal to r(t)
147
148	mmeineke	778	for(k = 0; k < 5; k ++){
149
150			for(i =0 ; i < nAtoms; i++){
151
152			atoms[i]->getVel(vel);
153			atoms[i]->getPos(pos);
154
155			this->getPosScale( pos, COM, i, sc );
156	tim	837
157	mmeineke	778	for(j = 0; j < 3; j++)
158			pos[j] = oldPos[i3 + j] + dt(vel[j] + sc[j]);
159
160			atoms[i]->setPos( pos );
161			}
162	tim	837
163	mmeineke	778	if (nConstrained){
164			constrainA();
165			}
166			}
167
168	tim	837
169	mmeineke	778	// Scale the box after all the positions have been moved:
170	tim	837
171	mmeineke	778	this->scaleSimBox();
172			}
173
174	mmeineke	849	void NPT::moveB( void ){
175	tim	837
176	mmeineke	778	//new version of NPT
177			int i, j, k;
178			DirectionalAtom* dAtom;
179			double Tb[3], ji[3], sc[3];
180			double vel[3], frc[3];
181			double mass;
182	tim	837
183	mmeineke	778	// Set things up for the iteration:
184
185			for( i=0; i<nAtoms; i++ ){
186
187			atoms[i]->getVel( vel );
188
189			for (j=0; j < 3; j++)
190			oldVel[3*i + j] = vel[j];
191
192			if( atoms[i]->isDirectional() ){
193
194			dAtom = (DirectionalAtom *)atoms[i];
195
196			dAtom->getJ( ji );
197
198			for (j=0; j < 3; j++)
199			oldJi[3*i + j] = ji[j];
200
201			}
202			}
203
204			// do the iteration:
205
206			instaVol = tStats->getVolume();
207	tim	837
208	mmeineke	778	for (k=0; k < 4; k++) {
209	tim	837
210	mmeineke	778	instaTemp = tStats->getTemperature();
211			instaPress = tStats->getPressure();
212
213			// evolve chi another half step using the temperature at t + dt/2
214
215			this->evolveChiB();
216			this->evolveEtaB();
217	tim	837
218	mmeineke	778	for( i=0; i<nAtoms; i++ ){
219
220			atoms[i]->getFrc( frc );
221			atoms[i]->getVel(vel);
222	tim	837
223	mmeineke	778	mass = atoms[i]->getMass();
224	tim	837
225	mmeineke	778	getVelScaleB( sc, i );
226
227			// velocity half step
228	tim	837	for (j=0; j < 3; j++)
229	mmeineke	778	vel[j] = oldVel[3i+j] + dt2 ((frc[j] / mass ) * eConvert - sc[j]);
230	tim	837
231	mmeineke	778	atoms[i]->setVel( vel );
232	tim	837
233	mmeineke	778	if( atoms[i]->isDirectional() ){
234
235			dAtom = (DirectionalAtom *)atoms[i];
236	tim	837
237			// get and convert the torque to body frame
238
239	mmeineke	778	dAtom->getTrq( Tb );
240	tim	837	dAtom->lab2Body( Tb );
241
242			for (j=0; j < 3; j++)
243	mmeineke	778	ji[j] = oldJi[3i + j] + dt2 (Tb[j] * eConvert - oldJi[3i+j]chi);
244	tim	837
245	mmeineke	778	dAtom->setJ( ji );
246			}
247			}
248	tim	837
249	mmeineke	778	if (nConstrained){
250			constrainB();
251	tim	837	}
252
253	mmeineke	778	if ( this->chiConverged() && this->etaConverged() ) break;
254			}
255
256			//calculate integral of chida
257			integralOfChidt += dt2*chi;
258
259
260			}
261
262	mmeineke	849	void NPT::resetIntegrator() {
263	mmeineke	778	chi = 0.0;
264	mmeineke	849	Integrator::resetIntegrator();
265	mmeineke	778	}
266
267	mmeineke	849	void NPT::evolveChiA() {
268	mmeineke	778	chi += dt2 * ( instaTemp / targetTemp - 1.0) / tt2;
269			oldChi = chi;
270			}
271
272	mmeineke	849	void NPT::evolveChiB() {
273	tim	837
274	mmeineke	778	prevChi = chi;
275			chi = oldChi + dt2 * ( instaTemp / targetTemp - 1.0) / tt2;
276			}
277
278	mmeineke	849	bool NPT::chiConverged() {
279	tim	837
280			return ( fabs( prevChi - chi ) <= chiTolerance );
281	mmeineke	778	}
282
283	mmeineke	849	int NPT::readyCheck() {
284	mmeineke	778
285			//check parent's readyCheck() first
286	mmeineke	849	if (Integrator::readyCheck() == -1)
287	mmeineke	778	return -1;
288	tim	837
289			// First check to see if we have a target temperature.
290			// Not having one is fatal.
291
292	mmeineke	778	if (!have_target_temp) {
293			sprintf( painCave.errMsg,
294			"NPT error: You can't use the NPT integrator\n"
295			" without a targetTemp!\n"
296			);
297			painCave.isFatal = 1;
298			simError();
299			return -1;
300			}
301
302			if (!have_target_pressure) {
303			sprintf( painCave.errMsg,
304			"NPT error: You can't use the NPT integrator\n"
305			" without a targetPressure!\n"
306			);
307			painCave.isFatal = 1;
308			simError();
309			return -1;
310			}
311	tim	837
312	mmeineke	778	// We must set tauThermostat.
313	tim	837
314	mmeineke	778	if (!have_tau_thermostat) {
315			sprintf( painCave.errMsg,
316			"NPT error: If you use the NPT\n"
317			" integrator, you must set tauThermostat.\n");
318			painCave.isFatal = 1;
319			simError();
320			return -1;
321	tim	837	}
322	mmeineke	778
323			// We must set tauBarostat.
324	tim	837
325	mmeineke	778	if (!have_tau_barostat) {
326			sprintf( painCave.errMsg,
327			"NPT error: If you use the NPT\n"
328			" integrator, you must set tauBarostat.\n");
329			painCave.isFatal = 1;
330			simError();
331			return -1;
332	tim	837	}
333	mmeineke	778
334			if (!have_chi_tolerance) {
335			sprintf( painCave.errMsg,
336			"NPT warning: setting chi tolerance to 1e-6\n");
337			chiTolerance = 1e-6;
338			have_chi_tolerance = 1;
339			painCave.isFatal = 0;
340			simError();
341	tim	837	}
342	mmeineke	778
343			if (!have_eta_tolerance) {
344			sprintf( painCave.errMsg,
345			"NPT warning: setting eta tolerance to 1e-6\n");
346			etaTolerance = 1e-6;
347			have_eta_tolerance = 1;
348			painCave.isFatal = 0;
349			simError();
350	tim	837	}
351
352	mmeineke	778	// We need NkBT a lot, so just set it here: This is the RAW number
353			// of particles, so no subtraction or addition of constraints or
354			// orientational degrees of freedom:
355	tim	837
356	mmeineke	778	NkBT = (double)Nparticles * kB * targetTemp;
357	tim	837
358	mmeineke	778	// fkBT is used because the thermostat operates on more degrees of freedom
359			// than the barostat (when there are particles with orientational degrees
360			// of freedom). ndf = 3 * (n_atoms + n_oriented -1) - n_constraint - nZcons
361	tim	837
362	mmeineke	778	fkBT = (double)info->ndf * kB * targetTemp;
363
364			tt2 = tauThermostat * tauThermostat;
365			tb2 = tauBarostat * tauBarostat;
366
367			return 1;
368			}