src/integrators/Integrator.hpp

/*
 * 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]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
/**
 * @file Integrator.hpp
 * @author tlin
 * @date 11/08/2004
 * @time 13:25am
 * @version 1.0
 */

#ifndef INTEGRATORS_INTEGRATOR_HPP
#define INTEGRATORS_INTEGRATOR_HPP

#include "brains/ForceManager.hpp"
#include "restraints/ThermoIntegrationForceManager.hpp"
#include "io/DumpWriter.hpp"
#include "io/StatWriter.hpp"
#include "integrators/Velocitizer.hpp"
#include "integrators/RNEMD.hpp"

namespace OpenMD {


  /**
   * @class Integrator Integrator.hpp "integrators/Integrator.hpp"
   * @brief Base class of Integrator
   * @todo document
   */
  class Integrator {
  public:

    virtual ~Integrator();

    //avoid public virtual function        
    void integrate() {
      doIntegrate();
    }

    void update() {
      doUpdate();
    }

    void setForceManager(ForceManager* forceMan) {

      if (forceMan_ != forceMan && forceMan_  != NULL) {
        delete forceMan_;
      }
      forceMan_ = forceMan;
    }

    void setVelocitizer(Velocitizer* velocitizer) {
      if (velocitizer_ != velocitizer && velocitizer_ != NULL) {
        delete velocitizer_;
      }
      velocitizer_ = velocitizer;
    }

    void setRNEMD(RNEMD* rnemd) {
      if (rnemd_ != rnemd && rnemd_  != NULL) {
        delete rnemd_;
      }
      rnemd_ = rnemd;
    }
    
  protected:

    Integrator(SimInfo* info);

    virtual void doIntegrate() = 0;

    virtual void doUpdate() {}
        
    void saveConservedQuantity() {
      currentSnapshot_->statData[Stats::CONSERVED_QUANTITY] = calcConservedQuantity();
    }
        
    SimInfo* info_;
    Globals* simParams;
    ForceManager* forceMan_;
    bool needPotential;
    bool needStress;
    bool needReset;    
    Velocitizer* velocitizer_;
    RNEMD* rnemd_;
    bool needVelocityScaling;
    RealType targetScalingTemp;

    bool useRNEMD;    
    
    DumpWriter* dumpWriter;
    StatWriter* statWriter;
    Thermo thermo;

    RealType runTime;
    RealType sampleTime;
    RealType statusTime;
    RealType thermalTime;
    RealType resetTime;
    RealType RNEMD_exchangeTime;
    RealType dt;

    Snapshot* currentSnapshot_; //During the integration, the address of currentSnapshot Will not change

        
  private:
        
    virtual RealType calcConservedQuantity() = 0;
        
    virtual DumpWriter* createDumpWriter() = 0;

    virtual StatWriter* createStatWriter() = 0;
  };

    
}
#endif //INTEGRATORS_INTEGRATOR_HPP
Revision:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	4565 byte(s)
Log Message:	updated copyright notices
#	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	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	246	*/
42
43	gezelter	507	/**
44			* @file Integrator.hpp
45			* @author tlin
46			* @date 11/08/2004
47			* @time 13:25am
48			* @version 1.0
49			*/
50	gezelter	2
51	gezelter	246	#ifndef INTEGRATORS_INTEGRATOR_HPP
52			#define INTEGRATORS_INTEGRATOR_HPP
53	gezelter	2
54	gezelter	246	#include "brains/ForceManager.hpp"
55	chrisfen	417	#include "restraints/ThermoIntegrationForceManager.hpp"
56	gezelter	246	#include "io/DumpWriter.hpp"
57			#include "io/StatWriter.hpp"
58			#include "integrators/Velocitizer.hpp"
59	gezelter	1329	#include "integrators/RNEMD.hpp"
60	gezelter	2
61	gezelter	1390	namespace OpenMD {
62	gezelter	2
63
64	gezelter	507	/**
65			* @class Integrator Integrator.hpp "integrators/Integrator.hpp"
66			* @brief Base class of Integrator
67			* @todo document
68			*/
69			class Integrator {
70			public:
71	gezelter	2
72	gezelter	507	virtual ~Integrator();
73	gezelter	2
74	gezelter	507	//avoid public virtual function
75			void integrate() {
76			doIntegrate();
77			}
78	gezelter	2
79	gezelter	507	void update() {
80			doUpdate();
81			}
82	gezelter	2
83	gezelter	507	void setForceManager(ForceManager* forceMan) {
84	cli2	1360
85	gezelter	507	if (forceMan_ != forceMan && forceMan_ != NULL) {
86			delete forceMan_;
87			}
88			forceMan_ = forceMan;
89			}
90	gezelter	2
91	gezelter	507	void setVelocitizer(Velocitizer* velocitizer) {
92	skuang	1368	if (velocitizer_ != velocitizer && velocitizer_ != NULL) {
93	gezelter	507	delete velocitizer_;
94			}
95	skuang	1368	velocitizer_ = velocitizer;
96	gezelter	507	}
97	gezelter	1329
98			void setRNEMD(RNEMD* rnemd) {
99			if (rnemd_ != rnemd && rnemd_ != NULL) {
100			delete rnemd_;
101			}
102	skuang	1368	rnemd_ = rnemd;
103	gezelter	1329	}
104	skuang	1368
105	gezelter	507	protected:
106	gezelter	2
107	gezelter	507	Integrator(SimInfo* info);
108	gezelter	2
109	gezelter	507	virtual void doIntegrate() = 0;
110	gezelter	2
111	gezelter	507	virtual void doUpdate() {}
112	gezelter	246
113	gezelter	507	void saveConservedQuantity() {
114			currentSnapshot_->statData[Stats::CONSERVED_QUANTITY] = calcConservedQuantity();
115			}
116	gezelter	246
117	gezelter	507	SimInfo* info_;
118			Globals* simParams;
119			ForceManager* forceMan_;
120			bool needPotential;
121			bool needStress;
122	tim	546	bool needReset;
123	gezelter	507	Velocitizer* velocitizer_;
124	gezelter	1329	RNEMD* rnemd_;
125	gezelter	507	bool needVelocityScaling;
126	tim	963	RealType targetScalingTemp;
127	gezelter	1329
128			bool useRNEMD;
129	gezelter	246
130	gezelter	507	DumpWriter* dumpWriter;
131			StatWriter* statWriter;
132			Thermo thermo;
133	gezelter	2
134	tim	963	RealType runTime;
135			RealType sampleTime;
136			RealType statusTime;
137			RealType thermalTime;
138			RealType resetTime;
139	skuang	1368	RealType RNEMD_exchangeTime;
140	tim	963	RealType dt;
141	gezelter	2
142	gezelter	507	Snapshot* currentSnapshot_; //During the integration, the address of currentSnapshot Will not change
143	gezelter	2
144	gezelter	246
145	gezelter	507	private:
146	gezelter	246
147	tim	963	virtual RealType calcConservedQuantity() = 0;
148	gezelter	246
149	gezelter	507	virtual DumpWriter* createDumpWriter() = 0;
150	tim	276
151	gezelter	507	virtual StatWriter* createStatWriter() = 0;
152			};
153	gezelter	2
154
155	gezelter	246	}
156			#endif //INTEGRATORS_INTEGRATOR_HPP