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, 234107 (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
 * @version 1.0
 */

#ifndef INTEGRATORS_INTEGRATOR_HPP
#define INTEGRATORS_INTEGRATOR_HPP

#include "brains/ForceManager.hpp"
#include "restraints/ThermoIntegrationForceManager.hpp"
#include "brains/Stats.hpp"
#include "io/DumpWriter.hpp"
#include "io/StatWriter.hpp"
#include "integrators/RotationAlgorithm.hpp"
#include "flucq/FluctuatingChargePropagator.hpp"
#include "integrators/Velocitizer.hpp"
#include "rnemd/RNEMD.hpp"
#include "constraints/Rattle.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 updateSizes() {
      doUpdateSizes();
      flucQ_->updateSizes();
    }

    void setForceManager(ForceManager* forceMan) {

      if (forceMan_ != forceMan && forceMan_  != NULL) {
        delete forceMan_;
      }
      forceMan_ = forceMan;
      // forward this on:
      if (flucQ_ != NULL) {
        flucQ_->setForceManager(forceMan_);
      }
    }

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

    void setFluctuatingChargePropagator(FluctuatingChargePropagator* prop) {
      if (prop != flucQ_ && flucQ_ != NULL){            
        delete flucQ_;
      }            
      flucQ_ = prop;
      if (forceMan_ != NULL) {
        flucQ_->setForceManager(forceMan_);
      }
    }

    void setRotationAlgorithm(RotationAlgorithm* algo) {
      if (algo != rotAlgo_ && rotAlgo_ != NULL){            
        delete rotAlgo_;
      }
            
      rotAlgo_ = algo;
    }

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

    Integrator(SimInfo* info);

    virtual void doIntegrate() = 0;

    virtual void doUpdateSizes() {}
        
    void saveConservedQuantity() {
      snap->setConservedQuantity( calcConservedQuantity() );
    }
        
    SimInfo* info_;
    Globals* simParams;
    ForceManager* forceMan_;
    RotationAlgorithm* rotAlgo_;
    FluctuatingChargePropagator* flucQ_;
    Rattle* rattle_;
    Velocitizer* velocitizer_;
    RNEMD* rnemd_;

    bool needPotential;
    bool needStress;
    bool needReset;    
    bool needVelocityScaling;
    RealType targetScalingTemp;

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

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

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

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

    virtual StatWriter* createStatWriter() = 0;
  };

    
}
#endif //INTEGRATORS_INTEGRATOR_HPP
Revision:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 2 months ago) by gezelter
File size:	5397 byte(s)
Log Message:	Fixed a widespread typo in the license
#	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	gezelter	1850	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (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			* @version 1.0
48			*/
49	gezelter	2
50	gezelter	246	#ifndef INTEGRATORS_INTEGRATOR_HPP
51			#define INTEGRATORS_INTEGRATOR_HPP
52	gezelter	2
53	gezelter	246	#include "brains/ForceManager.hpp"
54	chrisfen	417	#include "restraints/ThermoIntegrationForceManager.hpp"
55	gezelter	1764	#include "brains/Stats.hpp"
56	gezelter	246	#include "io/DumpWriter.hpp"
57			#include "io/StatWriter.hpp"
58	gezelter	1715	#include "integrators/RotationAlgorithm.hpp"
59	gezelter	1731	#include "flucq/FluctuatingChargePropagator.hpp"
60	gezelter	246	#include "integrators/Velocitizer.hpp"
61	gezelter	1731	#include "rnemd/RNEMD.hpp"
62	gezelter	1715	#include "constraints/Rattle.hpp"
63	gezelter	2
64	gezelter	1390	namespace OpenMD {
65	gezelter	2
66
67	gezelter	507	/**
68			* @class Integrator Integrator.hpp "integrators/Integrator.hpp"
69			* @brief Base class of Integrator
70			* @todo document
71			*/
72			class Integrator {
73			public:
74	gezelter	2
75	gezelter	507	virtual ~Integrator();
76	gezelter	2
77	gezelter	507	//avoid public virtual function
78			void integrate() {
79			doIntegrate();
80			}
81	gezelter	2
82	gezelter	1715	void updateSizes() {
83			doUpdateSizes();
84			flucQ_->updateSizes();
85	gezelter	507	}
86	gezelter	2
87	gezelter	507	void setForceManager(ForceManager* forceMan) {
88	cli2	1360
89	gezelter	507	if (forceMan_ != forceMan && forceMan_ != NULL) {
90			delete forceMan_;
91			}
92			forceMan_ = forceMan;
93	gezelter	1760	// forward this on:
94			if (flucQ_ != NULL) {
95			flucQ_->setForceManager(forceMan_);
96			}
97	gezelter	507	}
98	gezelter	2
99	gezelter	507	void setVelocitizer(Velocitizer* velocitizer) {
100	skuang	1368	if (velocitizer_ != velocitizer && velocitizer_ != NULL) {
101	gezelter	507	delete velocitizer_;
102			}
103	skuang	1368	velocitizer_ = velocitizer;
104	gezelter	507	}
105	gezelter	1329
106	gezelter	1715	void setFluctuatingChargePropagator(FluctuatingChargePropagator* prop) {
107			if (prop != flucQ_ && flucQ_ != NULL){
108			delete flucQ_;
109			}
110			flucQ_ = prop;
111	gezelter	1760	if (forceMan_ != NULL) {
112			flucQ_->setForceManager(forceMan_);
113			}
114	gezelter	1715	}
115
116			void setRotationAlgorithm(RotationAlgorithm* algo) {
117			if (algo != rotAlgo_ && rotAlgo_ != NULL){
118			delete rotAlgo_;
119			}
120
121			rotAlgo_ = algo;
122			}
123
124	gezelter	1329	void setRNEMD(RNEMD* rnemd) {
125			if (rnemd_ != rnemd && rnemd_ != NULL) {
126			delete rnemd_;
127			}
128	skuang	1368	rnemd_ = rnemd;
129	gezelter	1329	}
130	skuang	1368
131	gezelter	507	protected:
132	gezelter	2
133	gezelter	507	Integrator(SimInfo* info);
134	gezelter	2
135	gezelter	507	virtual void doIntegrate() = 0;
136	gezelter	2
137	gezelter	1715	virtual void doUpdateSizes() {}
138	gezelter	246
139	gezelter	507	void saveConservedQuantity() {
140	gezelter	1764	snap->setConservedQuantity( calcConservedQuantity() );
141	gezelter	507	}
142	gezelter	246
143	gezelter	507	SimInfo* info_;
144			Globals* simParams;
145			ForceManager* forceMan_;
146	gezelter	1715	RotationAlgorithm* rotAlgo_;
147			FluctuatingChargePropagator* flucQ_;
148			Rattle* rattle_;
149			Velocitizer* velocitizer_;
150			RNEMD* rnemd_;
151
152	gezelter	507	bool needPotential;
153			bool needStress;
154	tim	546	bool needReset;
155	gezelter	507	bool needVelocityScaling;
156	tim	963	RealType targetScalingTemp;
157	gezelter	1329
158			bool useRNEMD;
159	gezelter	246
160	gezelter	1764	Stats* stats;
161	gezelter	507	DumpWriter* dumpWriter;
162			StatWriter* statWriter;
163			Thermo thermo;
164	gezelter	2
165	tim	963	RealType runTime;
166			RealType sampleTime;
167			RealType statusTime;
168			RealType thermalTime;
169			RealType resetTime;
170	skuang	1368	RealType RNEMD_exchangeTime;
171	tim	963	RealType dt;
172	gezelter	2
173	gezelter	1764	Snapshot* snap; // During the integration, the address of snap Will not change
174	gezelter	2
175	gezelter	246
176	gezelter	507	private:
177	gezelter	246
178	tim	963	virtual RealType calcConservedQuantity() = 0;
179	gezelter	246
180	gezelter	507	virtual DumpWriter* createDumpWriter() = 0;
181	tim	276
182	gezelter	507	virtual StatWriter* createStatWriter() = 0;
183			};
184	gezelter	2
185
186	gezelter	246	}
187			#endif //INTEGRATORS_INTEGRATOR_HPP