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
 * @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:	1808
Committed:	Mon Oct 22 20:42:10 2012 UTC (12 years, 6 months ago) by gezelter
File size:	5396 byte(s)
Log Message:	A bug fix in the electric field for the new electrostatic code. Also comment fixes for Doxygen
#	Content
1	/*
2	* 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	* 1. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
12	* 2. Redistributions in binary form must reproduce the above copyright
13	* 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	*
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] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40	* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	*/
42
43	/**
44	* @file Integrator.hpp
45	* @author tlin
46	* @date 11/08/2004
47	* @version 1.0
48	*/
49
50	#ifndef INTEGRATORS_INTEGRATOR_HPP
51	#define INTEGRATORS_INTEGRATOR_HPP
52
53	#include "brains/ForceManager.hpp"
54	#include "restraints/ThermoIntegrationForceManager.hpp"
55	#include "brains/Stats.hpp"
56	#include "io/DumpWriter.hpp"
57	#include "io/StatWriter.hpp"
58	#include "integrators/RotationAlgorithm.hpp"
59	#include "flucq/FluctuatingChargePropagator.hpp"
60	#include "integrators/Velocitizer.hpp"
61	#include "rnemd/RNEMD.hpp"
62	#include "constraints/Rattle.hpp"
63
64	namespace OpenMD {
65
66
67	/**
68	* @class Integrator Integrator.hpp "integrators/Integrator.hpp"
69	* @brief Base class of Integrator
70	* @todo document
71	*/
72	class Integrator {
73	public:
74
75	virtual ~Integrator();
76
77	//avoid public virtual function
78	void integrate() {
79	doIntegrate();
80	}
81
82	void updateSizes() {
83	doUpdateSizes();
84	flucQ_->updateSizes();
85	}
86
87	void setForceManager(ForceManager* forceMan) {
88
89	if (forceMan_ != forceMan && forceMan_ != NULL) {
90	delete forceMan_;
91	}
92	forceMan_ = forceMan;
93	// forward this on:
94	if (flucQ_ != NULL) {
95	flucQ_->setForceManager(forceMan_);
96	}
97	}
98
99	void setVelocitizer(Velocitizer* velocitizer) {
100	if (velocitizer_ != velocitizer && velocitizer_ != NULL) {
101	delete velocitizer_;
102	}
103	velocitizer_ = velocitizer;
104	}
105
106	void setFluctuatingChargePropagator(FluctuatingChargePropagator* prop) {
107	if (prop != flucQ_ && flucQ_ != NULL){
108	delete flucQ_;
109	}
110	flucQ_ = prop;
111	if (forceMan_ != NULL) {
112	flucQ_->setForceManager(forceMan_);
113	}
114	}
115
116	void setRotationAlgorithm(RotationAlgorithm* algo) {
117	if (algo != rotAlgo_ && rotAlgo_ != NULL){
118	delete rotAlgo_;
119	}
120
121	rotAlgo_ = algo;
122	}
123
124	void setRNEMD(RNEMD* rnemd) {
125	if (rnemd_ != rnemd && rnemd_ != NULL) {
126	delete rnemd_;
127	}
128	rnemd_ = rnemd;
129	}
130
131	protected:
132
133	Integrator(SimInfo* info);
134
135	virtual void doIntegrate() = 0;
136
137	virtual void doUpdateSizes() {}
138
139	void saveConservedQuantity() {
140	snap->setConservedQuantity( calcConservedQuantity() );
141	}
142
143	SimInfo* info_;
144	Globals* simParams;
145	ForceManager* forceMan_;
146	RotationAlgorithm* rotAlgo_;
147	FluctuatingChargePropagator* flucQ_;
148	Rattle* rattle_;
149	Velocitizer* velocitizer_;
150	RNEMD* rnemd_;
151
152	bool needPotential;
153	bool needStress;
154	bool needReset;
155	bool needVelocityScaling;
156	RealType targetScalingTemp;
157
158	bool useRNEMD;
159
160	Stats* stats;
161	DumpWriter* dumpWriter;
162	StatWriter* statWriter;
163	Thermo thermo;
164
165	RealType runTime;
166	RealType sampleTime;
167	RealType statusTime;
168	RealType thermalTime;
169	RealType resetTime;
170	RealType RNEMD_exchangeTime;
171	RealType dt;
172
173	Snapshot* snap; // During the integration, the address of snap Will not change
174
175
176	private:
177
178	virtual RealType calcConservedQuantity() = 0;
179
180	virtual DumpWriter* createDumpWriter() = 0;
181
182	virtual StatWriter* createStatWriter() = 0;
183	};
184
185
186	}
187	#endif //INTEGRATORS_INTEGRATOR_HPP