src/rnemd/RNEMD.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]  Vardeman & Gezelter, in progress (2009).                        
 */
 
/**
 * @file RNEMD.hpp
 * @author gezelter
 * @date 03/13/2009
 * @time 15:56pm
 * @version 1.0
 */

#ifndef INTEGRATORS_RNEMD_HPP
#define INTEGRATORS_RNEMD_HPP
#include "brains/SimInfo.hpp"
#include "math/RandNumGen.hpp"
#include "selection/SelectionEvaluator.hpp"
#include "selection/SelectionManager.hpp"
#include <iostream>

using namespace std;
namespace OpenMD {

  /**
   * @class RNEMD RNEMD.hpp "integrators/RNEMD.hpp"
   * @todo document
   */
  class RNEMD {
  public:
    RNEMD(SimInfo* info);
    virtual ~RNEMD();
    
    void doRNEMD();
    void doSwap();
    void doScale();
    void collectData();
    void getStarted();
    void getStatus();
    void set_RNEMD_exchange_time(RealType exchangeTime) {
      exchangeTime_ = exchangeTime;
    }
    void set_RNEMD_nBins(int nbins) { nBins_ = nbins; }
    void set_RNEMD_logWidth(int logWidth) { rnemdLogWidth_ = logWidth; }
    void set_RNEMD_exchange_total(RealType et) { exchangeSum_ = et; }
    void set_RNEMD_target_flux(RealType targetFlux) {targetFlux_ = targetFlux;}
    RealType get_RNEMD_exchange_total() { return exchangeSum_; }

  private:

    enum RNEMDTypeEnum {
      rnemdKineticSwap,
      rnemdKineticScale,
      rnemdPxScale,
      rnemdPyScale,
      rnemdPzScale,
      rnemdPx,
      rnemdPy,
      rnemdPz,
      rnemdUnknown
    };
    
    SimInfo* info_;
    RandNumGen* randNumGen_;
    map<string, RNEMDTypeEnum> stringToEnumMap_;
    RNEMDTypeEnum rnemdType_;
    string rnemdObjectSelection_;
    SelectionEvaluator evaluator_;
    SelectionManager seleMan_;
    bool usePeriodicBoundaryConditions_;
    bool output3DTemp_;
    int nBins_; /**< The number of bins to divide the simulation box into.  */
    /*!
      The middle bin for the RNEMD method. midBin_ = nBins_/2;
      Depending on the setting of the flux, this box should contain the minimum energy (temperature)
      within the simulation. 
    */
    int midBin_;
    int rnemdLogWidth_; /**< Number of elements to print out in logs */
    RealType zShift_;
    RealType exchangeTime_;
    RealType targetFlux_;
    RealType exchangeSum_;
    int failTrialCount_;
    int failRootCount_;
    ofstream rnemdLog_;
    // keeps track of what's being averaged
    vector<RealType> valueHist_;
    vector<int> valueCount_, xyzTempCount_;
    // keeps track of the number of degrees of freedom being averaged
    vector<RealType> xTempHist_, yTempHist_, zTempHist_;
    ofstream xTempLog_, yTempLog_, zTempLog_;
  };

}
#endif //INTEGRATORS_RNEMD_HPP
Revision:	1629
Committed:	Wed Sep 14 21:15:17 2011 UTC (14 years, 1 month ago) by gezelter
Original Path:	*branches/development/src/integrators/RNEMD.hpp*
File size:	4624 byte(s)
Log Message:	Merging changes from old branch into development branch
#	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] Vardeman & Gezelter, in progress (2009).
40	*/
41
42	/**
43	* @file RNEMD.hpp
44	* @author gezelter
45	* @date 03/13/2009
46	* @time 15:56pm
47	* @version 1.0
48	*/
49
50	#ifndef INTEGRATORS_RNEMD_HPP
51	#define INTEGRATORS_RNEMD_HPP
52	#include "brains/SimInfo.hpp"
53	#include "math/RandNumGen.hpp"
54	#include "selection/SelectionEvaluator.hpp"
55	#include "selection/SelectionManager.hpp"
56	#include <iostream>
57
58	using namespace std;
59	namespace OpenMD {
60
61	/**
62	* @class RNEMD RNEMD.hpp "integrators/RNEMD.hpp"
63	* @todo document
64	*/
65	class RNEMD {
66	public:
67	RNEMD(SimInfo* info);
68	virtual ~RNEMD();
69
70	void doRNEMD();
71	void doSwap();
72	void doScale();
73	void collectData();
74	void getStarted();
75	void getStatus();
76	void set_RNEMD_exchange_time(RealType exchangeTime) {
77	exchangeTime_ = exchangeTime;
78	}
79	void set_RNEMD_nBins(int nbins) { nBins_ = nbins; }
80	void set_RNEMD_logWidth(int logWidth) { rnemdLogWidth_ = logWidth; }
81	void set_RNEMD_exchange_total(RealType et) { exchangeSum_ = et; }
82	void set_RNEMD_target_flux(RealType targetFlux) {targetFlux_ = targetFlux;}
83	RealType get_RNEMD_exchange_total() { return exchangeSum_; }
84
85	private:
86
87	enum RNEMDTypeEnum {
88	rnemdKineticSwap,
89	rnemdKineticScale,
90	rnemdPxScale,
91	rnemdPyScale,
92	rnemdPzScale,
93	rnemdPx,
94	rnemdPy,
95	rnemdPz,
96	rnemdUnknown
97	};
98
99	SimInfo* info_;
100	RandNumGen* randNumGen_;
101	map<string, RNEMDTypeEnum> stringToEnumMap_;
102	RNEMDTypeEnum rnemdType_;
103	string rnemdObjectSelection_;
104	SelectionEvaluator evaluator_;
105	SelectionManager seleMan_;
106	bool usePeriodicBoundaryConditions_;
107	bool output3DTemp_;
108	int nBins_; /*< The number of bins to divide the simulation box into. /
109	/*!
110	The middle bin for the RNEMD method. midBin_ = nBins_/2;
111	Depending on the setting of the flux, this box should contain the minimum energy (temperature)
112	within the simulation.
113	*/
114	int midBin_;
115	int rnemdLogWidth_; /*< Number of elements to print out in logs /
116	RealType zShift_;
117	RealType exchangeTime_;
118	RealType targetFlux_;
119	RealType exchangeSum_;
120	int failTrialCount_;
121	int failRootCount_;
122	ofstream rnemdLog_;
123	// keeps track of what's being averaged
124	vector<RealType> valueHist_;
125	vector<int> valueCount_, xyzTempCount_;
126	// keeps track of the number of degrees of freedom being averaged
127	vector<RealType> xTempHist_, yTempHist_, zTempHist_;
128	ofstream xTempLog_, yTempLog_, zTempLog_;
129	};
130
131	}
132	#endif //INTEGRATORS_RNEMD_HPP