src/brains/Stats.hpp

/*
 * Copyright (c) 2005, 2009 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 Stats.hpp
 * @author tlin
 * @date 11/04/2004
 * @time 23:56am
 * @version 1.0
 */

#ifndef BRAINS_STATS_HPP
#define BRAINS_STATS_HPP

#include <string>
#include <map>

#include "math/SquareMatrix3.hpp"
namespace OpenMD {

  /**
   * @class Stats Stats.hpp "brains/Stats.hpp"
   */
  class Stats{
  public:
    enum StatsIndex {
      BEGININDEX = 0,  //internal use
      TIME = BEGININDEX,            
      TOTAL_ENERGY,
      POTENTIAL_ENERGY,
      KINETIC_ENERGY,
      TEMPERATURE,
      PRESSURE,
      VOLUME,
      HULLVOLUME,
      GYRVOLUME,
      CONSERVED_QUANTITY,             
      TRANSLATIONAL_KINETIC,
      ROTATIONAL_KINETIC,
      LONG_RANGE_POTENTIAL,   
      SHORT_RANGE_POTENTIAL,
      VANDERWAALS_POTENTIAL,
      ELECTROSTATIC_POTENTIAL,
      BOND_POTENTIAL,
      BEND_POTENTIAL,
      DIHEDRAL_POTENTIAL,
      INVERSION_POTENTIAL,
      VRAW,
      VHARM,
      PRESSURE_TENSOR_XX,
      PRESSURE_TENSOR_XY,
      PRESSURE_TENSOR_XZ,
      PRESSURE_TENSOR_YX,
      PRESSURE_TENSOR_YY,
      PRESSURE_TENSOR_YZ,
      PRESSURE_TENSOR_ZX,
      PRESSURE_TENSOR_ZY,
      PRESSURE_TENSOR_ZZ,
      BOX_DIPOLE_X,
      BOX_DIPOLE_Y,
      BOX_DIPOLE_Z,
      TAGGED_PAIR_DISTANCE,
      RNEMD_EXCHANGE_TOTAL,
      SHADOWH,
      ENDINDEX  //internal use
    };

    Stats();
    const RealType& operator [](int index) const {
      assert(index >=0 && index < ENDINDEX);
      return data_[index];
    }

    RealType& operator [](int index){
      assert(index >=0 && index < ENDINDEX);            
      return data_[index];
    }
        
    static std::string getTitle(int index) {
      assert(index >=0 && index < ENDINDEX);
      return title_[index];
    }

    static std::string getUnits(int index) {
      assert(index >=0 && index < ENDINDEX);
      return units_[index];
    }

    typedef std::map<std::string, Stats::StatsIndex> StatsMapType;
    static  StatsMapType statsMap;
  
  private:
    static void init();
    static bool isInit_;
    RealType data_[ENDINDEX - BEGININDEX];
    static std::string title_[ENDINDEX - BEGININDEX];
    static std::string units_[ENDINDEX - BEGININDEX];
  };


} //end namespace OpenMD
#endif //BRAINS_STATS_HPP
Revision:	1709
Committed:	Tue May 15 13:04:08 2012 UTC (13 years, 2 months ago) by gezelter
File size:	4402 byte(s)
Log Message:	Moving silly stuff out of Stats and into Snapshot. Most of it should go into a not-yet-implemented FrameData class.
#	User	Rev	Content
1	gezelter	507	/*
2	chuckv	1402	* Copyright (c) 2005, 2009 The University of Notre Dame. All Rights Reserved.
3	gezelter	246	*
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 Stats.hpp
45			* @author tlin
46			* @date 11/04/2004
47			* @time 23:56am
48			* @version 1.0
49			*/
50	gezelter	246
51			#ifndef BRAINS_STATS_HPP
52			#define BRAINS_STATS_HPP
53
54			#include <string>
55	tim	681	#include <map>
56	gezelter	246
57			#include "math/SquareMatrix3.hpp"
58	gezelter	1390	namespace OpenMD {
59	gezelter	246
60	gezelter	507	/**
61			* @class Stats Stats.hpp "brains/Stats.hpp"
62			*/
63			class Stats{
64			public:
65			enum StatsIndex {
66			BEGININDEX = 0, //internal use
67			TIME = BEGININDEX,
68			TOTAL_ENERGY,
69			POTENTIAL_ENERGY,
70			KINETIC_ENERGY,
71			TEMPERATURE,
72			PRESSURE,
73			VOLUME,
74	gezelter	1291	HULLVOLUME,
75			GYRVOLUME,
76	gezelter	507	CONSERVED_QUANTITY,
77			TRANSLATIONAL_KINETIC,
78			ROTATIONAL_KINETIC,
79			LONG_RANGE_POTENTIAL,
80			SHORT_RANGE_POTENTIAL,
81			VANDERWAALS_POTENTIAL,
82			ELECTROSTATIC_POTENTIAL,
83			BOND_POTENTIAL,
84			BEND_POTENTIAL,
85			DIHEDRAL_POTENTIAL,
86	cli2	1275	INVERSION_POTENTIAL,
87	gezelter	507	VRAW,
88			VHARM,
89	gezelter	1126	PRESSURE_TENSOR_XX,
90			PRESSURE_TENSOR_XY,
91			PRESSURE_TENSOR_XZ,
92			PRESSURE_TENSOR_YX,
93			PRESSURE_TENSOR_YY,
94			PRESSURE_TENSOR_YZ,
95			PRESSURE_TENSOR_ZX,
96			PRESSURE_TENSOR_ZY,
97			PRESSURE_TENSOR_ZZ,
98	chrisfen	998	BOX_DIPOLE_X,
99			BOX_DIPOLE_Y,
100			BOX_DIPOLE_Z,
101	gezelter	1291	TAGGED_PAIR_DISTANCE,
102	skuang	1369	RNEMD_EXCHANGE_TOTAL,
103	chuckv	1402	SHADOWH,
104	gezelter	507	ENDINDEX //internal use
105			};
106	gezelter	246
107	gezelter	507	Stats();
108	tim	963	const RealType& operator [](int index) const {
109	gezelter	507	assert(index >=0 && index < ENDINDEX);
110			return data_[index];
111			}
112	gezelter	246
113	tim	963	RealType& operator [](int index){
114	gezelter	507	assert(index >=0 && index < ENDINDEX);
115			return data_[index];
116			}
117	gezelter	246
118	gezelter	507	static std::string getTitle(int index) {
119			assert(index >=0 && index < ENDINDEX);
120			return title_[index];
121			}
122	gezelter	246
123	gezelter	507	static std::string getUnits(int index) {
124			assert(index >=0 && index < ENDINDEX);
125			return units_[index];
126			}
127	gezelter	246
128	tim	681	typedef std::map<std::string, Stats::StatsIndex> StatsMapType;
129			static StatsMapType statsMap;
130
131	gezelter	507	private:
132			static void init();
133			static bool isInit_;
134	tim	963	RealType data_[ENDINDEX - BEGININDEX];
135	gezelter	507	static std::string title_[ENDINDEX - BEGININDEX];
136			static std::string units_[ENDINDEX - BEGININDEX];
137			};
138	gezelter	246
139	tim	681
140
141	gezelter	1390	} //end namespace OpenMD
142	gezelter	246	#endif //BRAINS_STATS_HPP