OOPSE/libmdtools/Integrator.hpp

#ifndef _INTEGRATOR_H_
#define _INTEGRATOR_H_

#include <string>
#include <vector>
#include "Atom.hpp"
#include "Molecule.hpp"
#include "SRI.hpp"
#include "AbstractClasses.hpp"
#include "SimInfo.hpp"
#include "ForceFields.hpp"
#include "Thermo.hpp"
#include "ReadWrite.hpp"
#include "ZConsWriter.hpp"

using namespace std;
const double kB = 8.31451e-7;// boltzmann constant amu*Ang^2*fs^-2/K
const double eConvert = 4.184e-4; // converts kcal/mol -> amu*A^2/fs^2
const double p_convert = 1.63882576e8; //converts amu*fs^-2*Ang^-1 -> atm
const int maxIteration = 300;
const double tol = 1.0e-6;


template<typename T = BaseIntegrator> class Integrator : public T {

public:
  Integrator( SimInfo *theInfo, ForceFields* the_ff );
  virtual ~Integrator();
  void integrate( void );
  virtual double  getConservedQuantity(void);
  virtual string getAdditionalParameters(void);

protected:

  virtual void integrateStep( int calcPot, int calcStress );
  virtual void preMove( void );
  virtual void moveA( void );
  virtual void moveB( void );
  virtual void constrainA( void );
  virtual void constrainB( void );
  virtual int  readyCheck( void ) { return 1; }

  virtual void resetIntegrator( void ) { }

  virtual void calcForce( int calcPot, int calcStress );
  virtual void thermalize();

  virtual void rotationPropagation( DirectionalAtom* dAtom, double ji[3] );

  void checkConstraints( void );
  void rotate( int axes1, int axes2, double angle, double j[3],
         double A[3][3] );

  ForceFields* myFF;

  SimInfo *info; // all the info we'll ever need
  int nAtoms;  /* the number of atoms */
  int oldAtoms;
  Atom **atoms; /* array of atom pointers */
  Molecule* molecules;
  int nMols;

  int isConstrained; // boolean to know whether the systems contains
         // constraints.
  int nConstrained;  // counter for number of constraints
  int *constrainedA; // the i of a constraint pair
  int *constrainedB; // the j of a constraint pair
  double *constrainedDsqr; // the square of the constraint distance

  int* moving; // tells whether we are moving atom i
  int* moved;  // tells whether we have moved atom i
  double* oldPos; // pre constrained positions

  short isFirst; /*boolean for the first time integrate is called */

  double dt;
  double dt2;

  Thermo *tStats;
  StatWriter*  statOut;
  DumpWriter*  dumpOut;

};

typedef Integrator<BaseIntegrator> RealIntegrator;

template<typename T> class NVE : public T {

public:
  NVE ( SimInfo *theInfo, ForceFields* the_ff ):
    T( theInfo, the_ff ){}
  virtual ~NVE(){}
};


template<typename T> class NVT : public T {

public:

  NVT ( SimInfo *theInfo, ForceFields* the_ff);
  virtual ~NVT();

  void setTauThermostat(double tt) {tauThermostat = tt; have_tau_thermostat=1;}
  void setTargetTemp(double tt) {targetTemp = tt; have_target_temp = 1;}
  void setChiTolerance(double tol) {chiTolerance = tol;}
  virtual double  getConservedQuantity(void);
  virtual string getAdditionalParameters(void);

protected:

  virtual void moveA( void );
  virtual void moveB( void );

  virtual int readyCheck();

  virtual void resetIntegrator( void );

  // chi is a propagated degree of freedom.

  double chi;

  //integral of chi(t)dt
  double integralOfChidt;

  // targetTemp must be set.  tauThermostat must also be set;

  double targetTemp;
  double tauThermostat;

  short int have_tau_thermostat, have_target_temp;

  double *oldVel;
  double *oldJi;

  double chiTolerance;
  short int have_chi_tolerance;

};


template<typename T> class NPT : public T{

public:

  NPT ( SimInfo *theInfo, ForceFields* the_ff);
  virtual ~NPT();

  virtual void integrateStep( int calcPot, int calcStress ){
    calcStress = 1;
    T::integrateStep( calcPot, calcStress );
  }

  virtual double getConservedQuantity(void) = 0;
  virtual string getAdditionalParameters(void) = 0;
  void setTauThermostat(double tt) {tauThermostat = tt; have_tau_thermostat=1;}
  void setTauBarostat(double tb) {tauBarostat = tb; have_tau_barostat=1;}
  void setTargetTemp(double tt) {targetTemp = tt; have_target_temp = 1;}
  void setTargetPressure(double tp) {targetPressure = tp; have_target_pressure = 1;}
  void setChiTolerance(double tol) {chiTolerance = tol; have_chi_tolerance = 1;}
  void setPosIterTolerance(double tol) {posIterTolerance = tol; have_pos_iter_tolerance = 1;}
  void setEtaTolerance(double tol) {etaTolerance = tol; have_eta_tolerance = 1;}

protected:

  virtual void  moveA( void );
  virtual void moveB( void );

  virtual int readyCheck();

  virtual void resetIntegrator( void );

  virtual void getVelScaleA( double sc[3], double vel[3] ) = 0;
  virtual void getVelScaleB( double sc[3], int index ) = 0;
  virtual void getPosScale(double pos[3], double COM[3],
                           int index, double sc[3]) = 0;

  virtual bool chiConverged( void );
  virtual bool etaConverged( void ) = 0;

  virtual void evolveChiA( void );
  virtual void evolveEtaA( void ) = 0;
  virtual void evolveChiB( void );
  virtual void evolveEtaB( void ) = 0;

  virtual void scaleSimBox( void ) = 0;

  void accIntegralOfChidt(void) { integralOfChidt += dt * chi;}

  // chi and eta are the propagated degrees of freedom

  double oldChi;
  double prevChi;
  double chi;
  double NkBT;
  double fkBT;

  double tt2, tb2;
  double instaTemp, instaPress, instaVol;
  double press[3][3];

  int Nparticles;

  double integralOfChidt;

  // targetTemp, targetPressure, and tauBarostat must be set.
  // One of qmass or tauThermostat must be set;

  double targetTemp;
  double targetPressure;
  double tauThermostat;
  double tauBarostat;

  short int have_tau_thermostat, have_tau_barostat, have_target_temp;
  short int have_target_pressure;

  double *oldPos;
  double *oldVel;
  double *oldJi;

  double chiTolerance;
  short int have_chi_tolerance;
  double posIterTolerance;
  short int have_pos_iter_tolerance;
  double etaTolerance;
  short int have_eta_tolerance;

};

template<typename T> class NPTi : public T{

public:
  NPTi( SimInfo *theInfo, ForceFields* the_ff);
  ~NPTi();

  virtual double getConservedQuantity(void);
  virtual void resetIntegrator(void);
  virtual string getAdditionalParameters(void);
protected:


  virtual void evolveEtaA(void);
  virtual void evolveEtaB(void);

  virtual bool etaConverged( void );

  virtual void scaleSimBox( void );

  virtual void getVelScaleA( double sc[3], double vel[3] );
  virtual void getVelScaleB( double sc[3], int index );
  virtual void getPosScale(double pos[3], double COM[3],
                           int index, double sc[3]);

  double eta, oldEta, prevEta;
};

template<typename T> class NPTf : public T{

public:

  NPTf ( SimInfo *theInfo, ForceFields* the_ff);
  virtual ~NPTf();

  virtual double getConservedQuantity(void);
  virtual string getAdditionalParameters(void);
  virtual void resetIntegrator(void);

protected:

  virtual void evolveEtaA(void);
  virtual void evolveEtaB(void);

  virtual bool etaConverged( void );

  virtual void scaleSimBox( void );

  virtual void getVelScaleA( double sc[3], double vel[3] );
  virtual void getVelScaleB( double sc[3], int index );
  virtual void getPosScale(double pos[3], double COM[3],
                           int index, double sc[3]);

  double eta[3][3];
  double oldEta[3][3];
  double prevEta[3][3];
};

template<typename T> class NPTxyz : public T{

public:

  NPTxyz ( SimInfo *theInfo, ForceFields* the_ff);
  virtual ~NPTxyz();

  virtual double getConservedQuantity(void);
  virtual string getAdditionalParameters(void);
  virtual void resetIntegrator(void);

protected:

  virtual void evolveEtaA(void);
  virtual void evolveEtaB(void);

  virtual bool etaConverged( void );

  virtual void scaleSimBox( void );

  virtual void getVelScaleA( double sc[3], double vel[3] );
  virtual void getVelScaleB( double sc[3], int index );
  virtual void getPosScale(double pos[3], double COM[3],
                           int index, double sc[3]);

  double eta[3][3];
  double oldEta[3][3];
  double prevEta[3][3];
};


template<typename T> class ZConstraint : public T {

  public:
  class ForceSubtractionPolicy{
    public:
      ForceSubtractionPolicy(ZConstraint<T>* integrator) {zconsIntegrator = integrator;}

      virtual void update() = 0;
      virtual double getZFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce) = 0;
      virtual double getZFOfMovingMols(Atom* atom, double totalForce) = 0;
      virtual double getHFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce) = 0;
      virtual double getHFOfUnconsMols(Atom* atom, double totalForce) = 0;

   protected:
     ZConstraint<T>* zconsIntegrator;
  };

  class PolicyByNumber : public ForceSubtractionPolicy{

    public:
      PolicyByNumber(ZConstraint<T>* integrator) :ForceSubtractionPolicy(integrator) {}
      virtual void update();
      virtual double getZFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce) ;
      virtual double getZFOfMovingMols(Atom* atom, double totalForce) ;
      virtual double getHFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce);
      virtual double getHFOfUnconsMols(Atom* atom, double totalForce);

    private:
      int totNumOfMovingAtoms;
  };

  class PolicyByMass : public ForceSubtractionPolicy{

    public:
      PolicyByMass(ZConstraint<T>* integrator) :ForceSubtractionPolicy(integrator) {}

      virtual void update();
      virtual double getZFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce) ;
      virtual double getZFOfMovingMols(Atom* atom, double totalForce) ;
      virtual double getHFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce);
      virtual double getHFOfUnconsMols(Atom* atom, double totalForce);

   private:
     double totMassOfMovingAtoms;
  };

public:

  ZConstraint( SimInfo *theInfo, ForceFields* the_ff);
  ~ZConstraint();

  void setZConsTime(double time)                  {this->zconsTime = time;}
  void getZConsTime()                             {return zconsTime;}

  void setIndexOfAllZConsMols(vector<int> index) {indexOfAllZConsMols = index;}
  void getIndexOfAllZConsMols()                  {return indexOfAllZConsMols;}

  void setZConsOutput(const char * fileName)          {zconsOutput = fileName;}
  string getZConsOutput()                         {return zconsOutput;}

  virtual void integrate();


#ifdef IS_MPI
  virtual void update();                      //which is called to indicate the molecules' migration
#endif

  enum ZConsState {zcsMoving, zcsFixed};

  vector<Molecule*> zconsMols;              //z-constraint molecules array
  vector<ZConsState> states;                 //state of z-constraint molecules


  int totNumOfUnconsAtoms;              //total number of uncontraint atoms
  double totalMassOfUncons;                //total mas of unconstraint molecules


protected:


  virtual void calcForce( int calcPot, int calcStress );
  virtual void thermalize(void);

  void zeroOutVel();
  void doZconstraintForce();
  void doHarmonic();
  bool checkZConsState();

  bool haveFixedZMols();
  bool haveMovingZMols();

  double calcZSys();

  int isZConstraintMol(Molecule* mol);


  double zconsTime;                              //sample time
  double zconsTol;                                 //tolerance of z-contratint
  double zForceConst;                           //base force constant term
                                                          //which is estimate by OOPSE


  vector<double> massOfZConsMols;       //mass of z-constraint molecule
  vector<double> kz;                              //force constant array

  vector<double> zPos;                          //


  vector<Molecule*> unconsMols;           //unconstraint molecules array
  vector<double> massOfUnconsMols;    //mass array of unconstraint molecules


  vector<ZConsParaItem>* parameters; //

  vector<int> indexOfAllZConsMols;     //index of All Z-Constraint Molecuels

  int* indexOfZConsMols;                   //index of local Z-Constraint Molecules
  double* fz;
  double* curZPos;


  int whichDirection;                           //constraint direction

private:

  string zconsOutput;                         //filename of zconstraint output
  ZConsWriter* fzOut;                         //z-constraint writer

  double curZconsTime;

  double calcMovingMolsCOMVel();
  double calcSysCOMVel();
  double calcTotalForce();

  ForceSubtractionPolicy* forcePolicy; //force subtraction policy
  friend class ForceSubtractionPolicy;

};

#endif
Revision:	837
Committed:	Wed Oct 29 00:19:10 2003 UTC (20 years, 8 months ago) by tim
File size:	12386 byte(s)
Log Message:	add chi and eta to the comment line of dump file.
#	User	Rev	Content
1	mmeineke	377	#ifndef _INTEGRATOR_H_
2			#define _INTEGRATOR_H_
3
4	tim	658	#include <string>
5			#include <vector>
6	mmeineke	377	#include "Atom.hpp"
7	gezelter	604	#include "Molecule.hpp"
8	mmeineke	377	#include "SRI.hpp"
9			#include "AbstractClasses.hpp"
10			#include "SimInfo.hpp"
11			#include "ForceFields.hpp"
12	mmeineke	540	#include "Thermo.hpp"
13			#include "ReadWrite.hpp"
14	tim	658	#include "ZConsWriter.hpp"
15	mmeineke	377
16	tim	658	using namespace std;
17	mmeineke	561	const double kB = 8.31451e-7;// boltzmann constant amuAng^2fs^-2/K
18			const double eConvert = 4.184e-4; // converts kcal/mol -> amu*A^2/fs^2
19	mmeineke	586	const double p_convert = 1.63882576e8; //converts amufs^-2Ang^-1 -> atm
20	mmeineke	561	const int maxIteration = 300;
21			const double tol = 1.0e-6;
22
23	mmeineke	377
24	tim	645	template<typename T = BaseIntegrator> class Integrator : public T {
25
26	mmeineke	377	public:
27	mmeineke	561	Integrator( SimInfo theInfo, ForceFields the_ff );
28	mmeineke	548	virtual ~Integrator();
29	mmeineke	377	void integrate( void );
30	tim	763	virtual double getConservedQuantity(void);
31	tim	837	virtual string getAdditionalParameters(void);
32	mmeineke	377
33	mmeineke	540	protected:
34	mmeineke	778
35	mmeineke	540	virtual void integrateStep( int calcPot, int calcStress );
36	mmeineke	548	virtual void preMove( void );
37	mmeineke	540	virtual void moveA( void );
38			virtual void moveB( void );
39			virtual void constrainA( void );
40			virtual void constrainB( void );
41	mmeineke	559	virtual int readyCheck( void ) { return 1; }
42	tim	677
43	mmeineke	746	virtual void resetIntegrator( void ) { }
44	tim	837
45			virtual void calcForce( int calcPot, int calcStress );
46	tim	677	virtual void thermalize();
47	tim	837
48	mmeineke	778	virtual void rotationPropagation( DirectionalAtom* dAtom, double ji[3] );
49
50	mmeineke	540	void checkConstraints( void );
51	tim	837	void rotate( int axes1, int axes2, double angle, double j[3],
52	tim	701	double A[3][3] );
53	tim	837
54	mmeineke	377	ForceFields* myFF;
55
56	mmeineke	540	SimInfo *info; // all the info we'll ever need
57			int nAtoms; /* the number of atoms */
58	mmeineke	548	int oldAtoms;
59	mmeineke	540	Atom *atoms; / array of atom pointers */
60	mmeineke	423	Molecule* molecules;
61			int nMols;
62
63	mmeineke	548	int isConstrained; // boolean to know whether the systems contains
64	tim	701	// constraints.
65	tim	837	int nConstrained; // counter for number of constraints
66			int *constrainedA; // the i of a constraint pair
67			int *constrainedB; // the j of a constraint pair
68			double *constrainedDsqr; // the square of the constraint distance
69
70	mmeineke	548	int* moving; // tells whether we are moving atom i
71			int* moved; // tells whether we have moved atom i
72	tim	837	double* oldPos; // pre constrained positions
73	mmeineke	548
74	mmeineke	540	short isFirst; /boolean for the first time integrate is called /
75	tim	837
76	mmeineke	540	double dt;
77	mmeineke	541	double dt2;
78	gezelter	560
79	mmeineke	540	Thermo *tStats;
80			StatWriter* statOut;
81			DumpWriter* dumpOut;
82	tim	837
83	mmeineke	377	};
84
85	tim	645	typedef Integrator<BaseIntegrator> RealIntegrator;
86	mmeineke	540
87	tim	645	template<typename T> class NVE : public T {
88
89	mmeineke	561	public:
90			NVE ( SimInfo theInfo, ForceFields the_ff ):
91	tim	645	T( theInfo, the_ff ){}
92	tim	837	virtual ~NVE(){}
93	tim	645	};
94	mmeineke	555
95
96	tim	645	template<typename T> class NVT : public T {
97	mmeineke	555
98	gezelter	560	public:
99
100	mmeineke	561	NVT ( SimInfo theInfo, ForceFields the_ff);
101	tim	763	virtual ~NVT();
102	mmeineke	540
103	gezelter	560	void setTauThermostat(double tt) {tauThermostat = tt; have_tau_thermostat=1;}
104			void setTargetTemp(double tt) {targetTemp = tt; have_target_temp = 1;}
105	tim	763	void setChiTolerance(double tol) {chiTolerance = tol;}
106			virtual double getConservedQuantity(void);
107	tim	837	virtual string getAdditionalParameters(void);
108	gezelter	560
109	mmeineke	540	protected:
110	gezelter	560
111	mmeineke	561	virtual void moveA( void );
112			virtual void moveB( void );
113	mmeineke	540
114	mmeineke	561	virtual int readyCheck();
115	gezelter	560
116	mmeineke	746	virtual void resetIntegrator( void );
117
118	gezelter	565	// chi is a propagated degree of freedom.
119	gezelter	560
120	gezelter	565	double chi;
121	gezelter	560
122	tim	763	//integral of chi(t)dt
123			double integralOfChidt;
124
125	gezelter	565	// targetTemp must be set. tauThermostat must also be set;
126	gezelter	560
127			double targetTemp;
128			double tauThermostat;
129	tim	837
130	gezelter	565	short int have_tau_thermostat, have_target_temp;
131	gezelter	560
132	tim	763	double *oldVel;
133			double *oldJi;
134
135			double chiTolerance;
136			short int have_chi_tolerance;
137
138	mmeineke	540	};
139
140
141
142	mmeineke	778	template<typename T> class NPT : public T{
143	tim	645
144	gezelter	560	public:
145
146	mmeineke	778	NPT ( SimInfo theInfo, ForceFields the_ff);
147			virtual ~NPT();
148	tim	837
149	mmeineke	594	virtual void integrateStep( int calcPot, int calcStress ){
150			calcStress = 1;
151	tim	645	T::integrateStep( calcPot, calcStress );
152	mmeineke	594	}
153
154	mmeineke	778	virtual double getConservedQuantity(void) = 0;
155	tim	837	virtual string getAdditionalParameters(void) = 0;
156	gezelter	560	void setTauThermostat(double tt) {tauThermostat = tt; have_tau_thermostat=1;}
157			void setTauBarostat(double tb) {tauBarostat = tb; have_tau_barostat=1;}
158			void setTargetTemp(double tt) {targetTemp = tt; have_target_temp = 1;}
159			void setTargetPressure(double tp) {targetPressure = tp; have_target_pressure = 1;}
160	tim	763	void setChiTolerance(double tol) {chiTolerance = tol; have_chi_tolerance = 1;}
161			void setPosIterTolerance(double tol) {posIterTolerance = tol; have_pos_iter_tolerance = 1;}
162			void setEtaTolerance(double tol) {etaTolerance = tol; have_eta_tolerance = 1;}
163	gezelter	560
164			protected:
165
166	mmeineke	561	virtual void moveA( void );
167			virtual void moveB( void );
168	gezelter	560
169	mmeineke	561	virtual int readyCheck();
170	gezelter	560
171	mmeineke	746	virtual void resetIntegrator( void );
172
173	mmeineke	778	virtual void getVelScaleA( double sc[3], double vel[3] ) = 0;
174			virtual void getVelScaleB( double sc[3], int index ) = 0;
175	tim	837	virtual void getPosScale(double pos[3], double COM[3],
176	mmeineke	778	int index, double sc[3]) = 0;
177
178			virtual bool chiConverged( void );
179			virtual bool etaConverged( void ) = 0;
180	tim	837
181	mmeineke	778	virtual void evolveChiA( void );
182			virtual void evolveEtaA( void ) = 0;
183			virtual void evolveChiB( void );
184			virtual void evolveEtaB( void ) = 0;
185
186			virtual void scaleSimBox( void ) = 0;
187
188	tim	763	void accIntegralOfChidt(void) { integralOfChidt += dt * chi;}
189
190	gezelter	565	// chi and eta are the propagated degrees of freedom
191	gezelter	560
192	mmeineke	778	double oldChi;
193			double prevChi;
194	gezelter	565	double chi;
195	gezelter	574	double NkBT;
196	tim	763	double fkBT;
197	gezelter	560
198	mmeineke	778	double tt2, tb2;
199			double instaTemp, instaPress, instaVol;
200	mmeineke	780	double press[3][3];
201	mmeineke	778
202	tim	763	int Nparticles;
203
204			double integralOfChidt;
205
206	tim	837	// targetTemp, targetPressure, and tauBarostat must be set.
207	gezelter	560	// One of qmass or tauThermostat must be set;
208
209			double targetTemp;
210			double targetPressure;
211			double tauThermostat;
212			double tauBarostat;
213
214			short int have_tau_thermostat, have_tau_barostat, have_target_temp;
215	gezelter	565	short int have_target_pressure;
216	gezelter	560
217	tim	763	double *oldPos;
218			double *oldVel;
219			double *oldJi;
220
221			double chiTolerance;
222			short int have_chi_tolerance;
223			double posIterTolerance;
224			short int have_pos_iter_tolerance;
225			double etaTolerance;
226			short int have_eta_tolerance;
227
228	gezelter	560	};
229
230	mmeineke	778	template<typename T> class NPTi : public T{
231	tim	837
232	mmeineke	778	public:
233			NPTi( SimInfo theInfo, ForceFields the_ff);
234			~NPTi();
235
236			virtual double getConservedQuantity(void);
237			virtual void resetIntegrator(void);
238	tim	837	virtual string getAdditionalParameters(void);
239	mmeineke	778	protected:
240
241
242	tim	837
243	mmeineke	778	virtual void evolveEtaA(void);
244			virtual void evolveEtaB(void);
245
246			virtual bool etaConverged( void );
247
248			virtual void scaleSimBox( void );
249
250			virtual void getVelScaleA( double sc[3], double vel[3] );
251			virtual void getVelScaleB( double sc[3], int index );
252	tim	837	virtual void getPosScale(double pos[3], double COM[3],
253	mmeineke	778	int index, double sc[3]);
254
255			double eta, oldEta, prevEta;
256			};
257
258	tim	645	template<typename T> class NPTf : public T{
259	gezelter	576
260			public:
261
262			NPTf ( SimInfo theInfo, ForceFields the_ff);
263	tim	767	virtual ~NPTf();
264	gezelter	576
265	tim	763	virtual double getConservedQuantity(void);
266	tim	837	virtual string getAdditionalParameters(void);
267	mmeineke	780	virtual void resetIntegrator(void);
268	mmeineke	594
269	gezelter	576	protected:
270
271	mmeineke	780	virtual void evolveEtaA(void);
272			virtual void evolveEtaB(void);
273	gezelter	576
274	mmeineke	780	virtual bool etaConverged( void );
275	mmeineke	746
276	mmeineke	780	virtual void scaleSimBox( void );
277	gezelter	576
278	mmeineke	780	virtual void getVelScaleA( double sc[3], double vel[3] );
279			virtual void getVelScaleB( double sc[3], int index );
280	tim	837	virtual void getPosScale(double pos[3], double COM[3],
281	mmeineke	780	int index, double sc[3]);
282	tim	763
283	gezelter	588	double eta[3][3];
284	mmeineke	780	double oldEta[3][3];
285			double prevEta[3][3];
286	gezelter	576	};
287
288	mmeineke	812	template<typename T> class NPTxyz : public T{
289	mmeineke	755
290			public:
291
292	mmeineke	812	NPTxyz ( SimInfo theInfo, ForceFields the_ff);
293			virtual ~NPTxyz();
294	mmeineke	755
295	mmeineke	812	virtual double getConservedQuantity(void);
296	tim	837	virtual string getAdditionalParameters(void);
297	mmeineke	812	virtual void resetIntegrator(void);
298	mmeineke	755
299			protected:
300
301	mmeineke	812	virtual void evolveEtaA(void);
302			virtual void evolveEtaB(void);
303	mmeineke	755
304	mmeineke	812	virtual bool etaConverged( void );
305	mmeineke	755
306	mmeineke	812	virtual void scaleSimBox( void );
307	mmeineke	755
308	mmeineke	812	virtual void getVelScaleA( double sc[3], double vel[3] );
309			virtual void getVelScaleB( double sc[3], int index );
310	tim	837	virtual void getPosScale(double pos[3], double COM[3],
311	mmeineke	812	int index, double sc[3]);
312	mmeineke	755
313	mmeineke	812	double eta[3][3];
314			double oldEta[3][3];
315			double prevEta[3][3];
316			};
317	mmeineke	755
318
319	tim	658	template<typename T> class ZConstraint : public T {
320	tim	837
321			public:
322	tim	738	class ForceSubtractionPolicy{
323	tim	699	public:
324	tim	738	ForceSubtractionPolicy(ZConstraint<T>* integrator) {zconsIntegrator = integrator;}
325	tim	658
326	tim	837	virtual void update() = 0;
327	tim	699	virtual double getZFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce) = 0;
328			virtual double getZFOfMovingMols(Atom* atom, double totalForce) = 0;
329	tim	701	virtual double getHFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce) = 0;
330			virtual double getHFOfUnconsMols(Atom* atom, double totalForce) = 0;
331	tim	837
332	tim	701	protected:
333	mmeineke	788	ZConstraint<T>* zconsIntegrator;
334	tim	699	};
335
336	tim	738	class PolicyByNumber : public ForceSubtractionPolicy{
337	gezelter	747
338	tim	699	public:
339	tim	837	PolicyByNumber(ZConstraint<T>* integrator) :ForceSubtractionPolicy(integrator) {}
340			virtual void update();
341	tim	699	virtual double getZFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce) ;
342			virtual double getZFOfMovingMols(Atom* atom, double totalForce) ;
343	tim	701	virtual double getHFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce);
344			virtual double getHFOfUnconsMols(Atom* atom, double totalForce);
345	tim	837
346	tim	699	private:
347	tim	763	int totNumOfMovingAtoms;
348	tim	699	};
349
350	tim	738	class PolicyByMass : public ForceSubtractionPolicy{
351	gezelter	747
352	tim	699	public:
353	tim	837	PolicyByMass(ZConstraint<T>* integrator) :ForceSubtractionPolicy(integrator) {}
354
355			virtual void update();
356	tim	699	virtual double getZFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce) ;
357			virtual double getZFOfMovingMols(Atom* atom, double totalForce) ;
358	tim	701	virtual double getHFOfFixedZMols(Molecule* mol, Atom* atom, double totalForce);
359			virtual double getHFOfUnconsMols(Atom* atom, double totalForce);
360	tim	699
361	tim	701	private:
362			double totMassOfMovingAtoms;
363	tim	699	};
364
365	tim	658	public:
366
367			ZConstraint( SimInfo theInfo, ForceFields the_ff);
368			~ZConstraint();
369	tim	837
370	tim	658	void setZConsTime(double time) {this->zconsTime = time;}
371			void getZConsTime() {return zconsTime;}
372	tim	837
373	tim	701	void setIndexOfAllZConsMols(vector<int> index) {indexOfAllZConsMols = index;}
374			void getIndexOfAllZConsMols() {return indexOfAllZConsMols;}
375	tim	837
376	tim	701	void setZConsOutput(const char * fileName) {zconsOutput = fileName;}
377	tim	658	string getZConsOutput() {return zconsOutput;}
378	tim	837
379	tim	677	virtual void integrate();
380	tim	658
381	tim	837
382	tim	658	#ifdef IS_MPI
383	tim	701	virtual void update(); //which is called to indicate the molecules' migration
384	mmeineke	377	#endif
385	tim	658
386	tim	837	enum ZConsState {zcsMoving, zcsFixed};
387	mmeineke	790
388			vector<Molecule*> zconsMols; //z-constraint molecules array
389			vector<ZConsState> states; //state of z-constraint molecules
390
391
392	tim	837
393	mmeineke	790	int totNumOfUnconsAtoms; //total number of uncontraint atoms
394			double totalMassOfUncons; //total mas of unconstraint molecules
395
396
397	tim	658	protected:
398
399	mmeineke	790
400	tim	837
401			virtual void calcForce( int calcPot, int calcStress );
402	tim	677	virtual void thermalize(void);
403	tim	837
404	tim	677	void zeroOutVel();
405			void doZconstraintForce();
406	tim	682	void doHarmonic();
407	tim	677	bool checkZConsState();
408
409			bool haveFixedZMols();
410			bool haveMovingZMols();
411
412			double calcZSys();
413
414			int isZConstraintMol(Molecule* mol);
415
416
417	tim	701	double zconsTime; //sample time
418			double zconsTol; //tolerance of z-contratint
419			double zForceConst; //base force constant term
420			//which is estimate by OOPSE
421	mmeineke	790
422	tim	837
423			vector<double> massOfZConsMols; //mass of z-constraint molecule
424	tim	701	vector<double> kz; //force constant array
425	mmeineke	790
426	tim	701	vector<double> zPos; //
427	tim	837
428
429	tim	701	vector<Molecule*> unconsMols; //unconstraint molecules array
430			vector<double> massOfUnconsMols; //mass array of unconstraint molecules
431	tim	682
432	mmeineke	790
433	tim	701	vector<ZConsParaItem>* parameters; //
434	tim	837
435	tim	658	vector<int> indexOfAllZConsMols; //index of All Z-Constraint Molecuels
436	tim	677
437	tim	837	int* indexOfZConsMols; //index of local Z-Constraint Molecules
438	tim	658	double* fz;
439	tim	699	double* curZPos;
440	tim	677
441	mmeineke	790
442	tim	837
443			int whichDirection; //constraint direction
444
445	tim	658	private:
446	tim	837
447	tim	701	string zconsOutput; //filename of zconstraint output
448			ZConsWriter* fzOut; //z-constraint writer
449	tim	677
450	tim	837	double curZconsTime;
451	tim	699
452	tim	696	double calcMovingMolsCOMVel();
453			double calcSysCOMVel();
454			double calcTotalForce();
455	tim	837
456	gezelter	747	ForceSubtractionPolicy* forcePolicy; //force subtraction policy
457	tim	738	friend class ForceSubtractionPolicy;
458	tim	677
459	tim	658	};
460
461			#endif