src/integrators/NPTxyz.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).                        
 */
 
#include "brains/SimInfo.hpp"
#include "brains/Thermo.hpp"
#include "integrators/IntegratorCreator.hpp"
#include "integrators/NPTxyz.hpp"
#include "primitives/Molecule.hpp"
#include "utils/PhysicalConstants.hpp"
#include "utils/simError.h"

// Basic non-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.

namespace OpenMD {

    
  RealType NPTxyz::calcConservedQuantity(){

    // We need NkBT a lot, so just set it here: This is the RAW number
    // of integrableObjects, so no subtraction or addition of constraints or
    // orientational degrees of freedom:
    NkBT = info_->getNGlobalIntegrableObjects()*PhysicalConstants::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).  
    fkBT = info_->getNdf()*PhysicalConstants::kB *targetTemp;        

    RealType conservedQuantity;
    RealType totalEnergy;
    RealType thermostat_kinetic;
    RealType thermostat_potential;
    RealType barostat_kinetic;
    RealType barostat_potential;
    RealType trEta;

    totalEnergy = thermo.getTotalE();

    thermostat_kinetic = fkBT * tt2 * chi * chi /(2.0 * PhysicalConstants::energyConvert);

    thermostat_potential = fkBT* integralOfChidt / PhysicalConstants::energyConvert;

    SquareMatrix<RealType, 3> tmp = eta.transpose() * eta;
    trEta = tmp.trace();

    barostat_kinetic = NkBT * tb2 * trEta /(2.0 * PhysicalConstants::energyConvert);

    barostat_potential = (targetPressure * thermo.getVolume() / PhysicalConstants::pressureConvert) /PhysicalConstants::energyConvert;

    conservedQuantity = totalEnergy + thermostat_kinetic + thermostat_potential +
      barostat_kinetic + barostat_potential;


    return conservedQuantity;

  }

    
  void NPTxyz::scaleSimBox(){

    int i,j,k;
    Mat3x3d scaleMat;
    RealType eta2ij, scaleFactor;
    RealType bigScale, smallScale, offDiagMax;
    Mat3x3d hm;
    Mat3x3d hmnew;


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

    // Use a taylor expansion for eta products:  Hmat = Hmat . exp(dt * etaMat)
    //  Hmat = Hmat . ( Ident + dt * etaMat  + dt^2 * etaMat*etaMat / 2)

    bigScale = 1.0;
    smallScale = 1.0;
    offDiagMax = 0.0;

    for(i=0; i<3; i++){
      for(j=0; j<3; j++){
        scaleMat(i, j) = 0.0;
        if(i==j) {
          scaleMat(i, j) = 1.0;
        }
      }
    }

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

      // calculate the scaleFactors

      scaleFactor = exp(dt*eta(i, i));

      scaleMat(i, i) = scaleFactor;

      if (scaleMat(i, i) > bigScale) {
        bigScale = scaleMat(i, i);
      }
        
      if (scaleMat(i, i) < smallScale) {
        smallScale = scaleMat(i, i);
      }
    }

    if ((bigScale > 1.1) || (smallScale < 0.9)) {
      sprintf( painCave.errMsg,
               "NPTxyz error: Attempting a Box scaling of more than 10 percent.\n"
               " Check your tauBarostat, as it is probably too small!\n\n"
               " scaleMat = [%lf\t%lf\t%lf]\n"
               "            [%lf\t%lf\t%lf]\n"
               "            [%lf\t%lf\t%lf]\n",
               scaleMat(0, 0),scaleMat(0, 1),scaleMat(0, 2),
               scaleMat(1, 0),scaleMat(1, 1),scaleMat(1, 2),
               scaleMat(2, 0),scaleMat(2, 1),scaleMat(2, 2));
      painCave.isFatal = 1;
      simError();
    } else {

      Mat3x3d hmat = currentSnapshot_->getHmat();
      hmat = hmat *scaleMat;
      currentSnapshot_->setHmat(hmat);
    }
  }

  void NPTxyz::loadEta() {
    eta= currentSnapshot_->getEta();
  }

}
Revision:	1390
Committed:	Wed Nov 25 20:02:06 2009 UTC (15 years, 11 months ago) by gezelter
File size:	5814 byte(s)
Log Message:	Almost all of the changes necessary to create OpenMD out of our old project (OOPSE-4)
#	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	tim	3	#include "brains/SimInfo.hpp"
43			#include "brains/Thermo.hpp"
44	gezelter	246	#include "integrators/IntegratorCreator.hpp"
45			#include "integrators/NPTxyz.hpp"
46			#include "primitives/Molecule.hpp"
47	gezelter	1390	#include "utils/PhysicalConstants.hpp"
48	tim	3	#include "utils/simError.h"
49	gezelter	2
50			// Basic non-isotropic thermostating and barostating via the Melchionna
51			// modification of the Hoover algorithm:
52			//
53			// Melchionna, S., Ciccotti, G., and Holian, B. L., 1993,
54			// Molec. Phys., 78, 533.
55			//
56			// and
57			//
58			// Hoover, W. G., 1986, Phys. Rev. A, 34, 2499.
59
60	gezelter	1390	namespace OpenMD {
61	gezelter	2
62	gezelter	246
63	tim	963	RealType NPTxyz::calcConservedQuantity(){
64	gezelter	2
65	gezelter	246	// We need NkBT a lot, so just set it here: This is the RAW number
66			// of integrableObjects, so no subtraction or addition of constraints or
67			// orientational degrees of freedom:
68	gezelter	1390	NkBT = info_->getNGlobalIntegrableObjects()PhysicalConstants::kB targetTemp;
69	gezelter	2
70	gezelter	246	// fkBT is used because the thermostat operates on more degrees of freedom
71			// than the barostat (when there are particles with orientational degrees
72			// of freedom).
73	gezelter	1390	fkBT = info_->getNdf()PhysicalConstants::kB targetTemp;
74	gezelter	2
75	tim	963	RealType conservedQuantity;
76			RealType totalEnergy;
77			RealType thermostat_kinetic;
78			RealType thermostat_potential;
79			RealType barostat_kinetic;
80			RealType barostat_potential;
81			RealType trEta;
82	gezelter	2
83	gezelter	246	totalEnergy = thermo.getTotalE();
84	gezelter	2
85	gezelter	1390	thermostat_kinetic = fkBT * tt2 * chi * chi /(2.0 * PhysicalConstants::energyConvert);
86	gezelter	2
87	gezelter	1390	thermostat_potential = fkBT* integralOfChidt / PhysicalConstants::energyConvert;
88	gezelter	2
89	tim	963	SquareMatrix<RealType, 3> tmp = eta.transpose() * eta;
90	gezelter	246	trEta = tmp.trace();
91	gezelter	2
92	gezelter	1390	barostat_kinetic = NkBT * tb2 * trEta /(2.0 * PhysicalConstants::energyConvert);
93	gezelter	2
94	gezelter	1390	barostat_potential = (targetPressure * thermo.getVolume() / PhysicalConstants::pressureConvert) /PhysicalConstants::energyConvert;
95	gezelter	2
96	gezelter	246	conservedQuantity = totalEnergy + thermostat_kinetic + thermostat_potential +
97	gezelter	507	barostat_kinetic + barostat_potential;
98	gezelter	2
99
100	gezelter	246	return conservedQuantity;
101	gezelter	2
102	gezelter	507	}
103	gezelter	2
104	gezelter	246
105	gezelter	507	void NPTxyz::scaleSimBox(){
106	gezelter	2
107	gezelter	246	int i,j,k;
108			Mat3x3d scaleMat;
109	tim	963	RealType eta2ij, scaleFactor;
110			RealType bigScale, smallScale, offDiagMax;
111	gezelter	246	Mat3x3d hm;
112			Mat3x3d hmnew;
113	gezelter	2
114
115
116	gezelter	507	// Scale the box after all the positions have been moved:
117	gezelter	2
118	gezelter	507	// Use a taylor expansion for eta products: Hmat = Hmat . exp(dt * etaMat)
119			// Hmat = Hmat . ( Ident + dt * etaMat + dt^2 * etaMat*etaMat / 2)
120	gezelter	2
121	gezelter	246	bigScale = 1.0;
122			smallScale = 1.0;
123			offDiagMax = 0.0;
124	gezelter	2
125	gezelter	246	for(i=0; i<3; i++){
126	gezelter	507	for(j=0; j<3; j++){
127			scaleMat(i, j) = 0.0;
128			if(i==j) {
129			scaleMat(i, j) = 1.0;
130			}
131			}
132	gezelter	2	}
133
134	gezelter	246	for(i=0;i<3;i++){
135	gezelter	2
136	gezelter	507	// calculate the scaleFactors
137	gezelter	2
138	gezelter	507	scaleFactor = exp(dt*eta(i, i));
139	gezelter	2
140	gezelter	507	scaleMat(i, i) = scaleFactor;
141	gezelter	2
142	gezelter	507	if (scaleMat(i, i) > bigScale) {
143			bigScale = scaleMat(i, i);
144			}
145	gezelter	246
146	gezelter	507	if (scaleMat(i, i) < smallScale) {
147			smallScale = scaleMat(i, i);
148			}
149	gezelter	246	}
150	gezelter	2
151	gezelter	246	if ((bigScale > 1.1) \|\| (smallScale < 0.9)) {
152	gezelter	507	sprintf( painCave.errMsg,
153			"NPTxyz error: Attempting a Box scaling of more than 10 percent.\n"
154			" Check your tauBarostat, as it is probably too small!\n\n"
155			" scaleMat = [%lf\t%lf\t%lf]\n"
156			" [%lf\t%lf\t%lf]\n"
157			" [%lf\t%lf\t%lf]\n",
158			scaleMat(0, 0),scaleMat(0, 1),scaleMat(0, 2),
159			scaleMat(1, 0),scaleMat(1, 1),scaleMat(1, 2),
160			scaleMat(2, 0),scaleMat(2, 1),scaleMat(2, 2));
161			painCave.isFatal = 1;
162			simError();
163	gezelter	246	} else {
164	gezelter	2
165	gezelter	507	Mat3x3d hmat = currentSnapshot_->getHmat();
166			hmat = hmat *scaleMat;
167			currentSnapshot_->setHmat(hmat);
168	gezelter	246	}
169	gezelter	507	}
170	gezelter	2
171	gezelter	507	void NPTxyz::loadEta() {
172	gezelter	246	eta= currentSnapshot_->getEta();
173	gezelter	507	}
174	gezelter	2
175			}