src/brains/DataStorage.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 Vector.hpp
 * @author Teng Lin
 * @date 09/14/2004
 * @version 1.0
 */

#ifndef BRAINS_DATASTORAGE_HPP
#define BRAINS_DATASTORAGE_HPP

#include <vector>
#include <math/Vector3.hpp>
#include <math/SquareMatrix3.hpp>

using namespace std;
namespace OpenMD {
  /**
   * @class DataStorage
   * @warning do not try to insert element into (or ease element from) private member data 
   * of DataStorage directly.
   * @todo DataStorage may need refactoring. Every vector can inherit from the same base class
   * which will make it easy to maintain
   */
  class DataStorage {
  public:

    enum{
      dslPosition = 1,
      dslVelocity = 2,
      dslAmat = 4, 
      dslAngularMomentum = 8,
      dslElectroFrame = 16,
      dslZAngle = 32,
      dslForce = 64, 
      dslTorque = 128,
      dslParticlePot = 256,
      dslDensity = 512,
      dslFunctional = 1024,
      dslFunctionalDerivative = 2048,
      dslElectricField = 4096,
      dslSkippedCharge = 8192,
      dslFlucQPosition = 16384,
      dslFlucQVelocity = 32768,
      dslFlucQForce = 65536
    };

    DataStorage();
    DataStorage(int size, int storageLayout = 0);
    /** return the size of this DataStorage. */
    int getSize();
    /**
     * Changes the size of this DataStorage.
     * @param size new size of this DataStorage
     */
    void resize(int newSize);
    /**
     * Reallocates memory manually. 
     *
     * The main reason for using reserve() is efficiency if you know
     * the capacity to which your vector must eventually grow,
     * then it is usually more efficient to allocate that memory all
     * at once.
     */
    void reserve(int size);
    /**
     * Copies data inside DataStorage class.
     *
     * Copy function actually calls copy for every vector in
     * DataStorage class.  One Precondition of copy is that
     * target is not within the range [source, soruce + num]
     *
     * @param source 
     * @param num number of element to be moved
     * @param target
     */
    void copy(int source, int num, int target);
    /** Returns the storage layout  */
    int getStorageLayout();
    /** Sets the storage layout  */
    void setStorageLayout(int layout);
    /** Returns the pointer of internal array */
    RealType *getArrayPointer(int whichArray);

    vector<Vector3d> position;        /** position array */
    vector<Vector3d> velocity;        /** velocity array */
    vector<RotMat3x3d> aMat;          /** rotation matrix array */
    vector<Vector3d> angularMomentum; /** angular momentum array (body-fixed) */
    vector<Mat3x3d> electroFrame;     /** the lab frame unit vector array*/
    vector<RealType> zAngle;          /** z-angle array */        
    vector<Vector3d> force;           /** force array */
    vector<Vector3d> torque;          /** torque array */
    vector<RealType> particlePot;     /** particle potential arrray */
    vector<RealType> density;         /** electron density */
    vector<RealType> functional;      /** density functional */
    vector<RealType> functionalDerivative; /** derivative of functional */
    vector<Vector3d> electricField;   /** local electric field */
    vector<RealType> skippedCharge;   /** charge skipped during normal pairwise calculation */
    vector<RealType> flucQPos;        /** fluctuating charges */
    vector<RealType> flucQVel;        /** fluctuating charge velocities */
    vector<RealType> flucQFrc;        /** fluctuating charge forces */

    static int getBytesPerStuntDouble(int layout);

  private:

    RealType* internalGetArrayPointer(vector<Vector3d>& v);            
    RealType* internalGetArrayPointer(vector<RotMat3x3d>& v);
    RealType* internalGetArrayPointer(vector<RealType>& v);

            
    template<typename T>
    void internalResize(std::vector<T>& v, int newSize);

    template<typename T>
    void internalCopy(std::vector<T>& v, int source,  int num, int target);
            
    int size_;
    int storageLayout_;

  };

}
#endif //BRAINS_DATASTORAGE_HPP
Revision:	1710
Committed:	Fri May 18 21:44:02 2012 UTC (12 years, 11 months ago) by gezelter
File size:	6195 byte(s)
Log Message:	Added an adapter layer between the AtomType and the rest of the code to handle the bolt-on capabilities of new types. Fixed a long-standing bug in how storageLayout was being set to the maximum possible value. Started to add infrastructure for Polarizable and fluc-Q calculations.
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	tim	155	*
4	gezelter	246	* 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	tim	155	*/
42	gezelter	246
43	tim	155	/**
44			* @file Vector.hpp
45			* @author Teng Lin
46			* @date 09/14/2004
47			* @version 1.0
48			*/
49
50			#ifndef BRAINS_DATASTORAGE_HPP
51			#define BRAINS_DATASTORAGE_HPP
52
53			#include <vector>
54			#include <math/Vector3.hpp>
55			#include <math/SquareMatrix3.hpp>
56
57	gezelter	1710	using namespace std;
58	gezelter	1390	namespace OpenMD {
59	gezelter	507	/**
60			* @class DataStorage
61			* @warning do not try to insert element into (or ease element from) private member data
62			* of DataStorage directly.
63	gezelter	1584	* @todo DataStorage may need refactoring. Every vector can inherit from the same base class
64	gezelter	507	* which will make it easy to maintain
65			*/
66			class DataStorage {
67			public:
68	tim	155
69	gezelter	507	enum{
70			dslPosition = 1,
71			dslVelocity = 2,
72			dslAmat = 4,
73			dslAngularMomentum = 8,
74			dslElectroFrame = 16,
75			dslZAngle = 32,
76			dslForce = 64,
77	chuckv	1245	dslTorque = 128,
78	gezelter	1540	dslParticlePot = 256,
79			dslDensity = 512,
80			dslFunctional = 1024,
81			dslFunctionalDerivative = 2048,
82	gezelter	1584	dslElectricField = 4096,
83	gezelter	1710	dslSkippedCharge = 8192,
84			dslFlucQPosition = 16384,
85			dslFlucQVelocity = 32768,
86			dslFlucQForce = 65536
87	gezelter	507	};
88	tim	155
89	gezelter	507	DataStorage();
90	gezelter	1710	DataStorage(int size, int storageLayout = 0);
91	gezelter	507	/** return the size of this DataStorage. */
92			int getSize();
93			/**
94			* Changes the size of this DataStorage.
95			* @param size new size of this DataStorage
96			*/
97			void resize(int newSize);
98			/**
99	gezelter	1540	* Reallocates memory manually.
100			*
101			* The main reason for using reserve() is efficiency if you know
102	gezelter	1584	* the capacity to which your vector must eventually grow,
103	gezelter	1540	* then it is usually more efficient to allocate that memory all
104			* at once.
105	gezelter	507	*/
106			void reserve(int size);
107			/**
108			* Copies data inside DataStorage class.
109	gezelter	1540	*
110	gezelter	1710	* Copy function actually calls copy for every vector in
111	gezelter	1584	* DataStorage class. One Precondition of copy is that
112			* target is not within the range [source, soruce + num]
113	gezelter	1540	*
114	gezelter	1710	* @param source
115	gezelter	507	* @param num number of element to be moved
116			* @param target
117			*/
118			void copy(int source, int num, int target);
119			/** Returns the storage layout */
120			int getStorageLayout();
121			/** Sets the storage layout */
122			void setStorageLayout(int layout);
123			/** Returns the pointer of internal array */
124	tim	963	RealType *getArrayPointer(int whichArray);
125	gezelter	246
126	gezelter	1710	vector<Vector3d> position; /** position array */
127			vector<Vector3d> velocity; /** velocity array */
128			vector<RotMat3x3d> aMat; /** rotation matrix array */
129			vector<Vector3d> angularMomentum; /** angular momentum array (body-fixed) */
130			vector<Mat3x3d> electroFrame; /** the lab frame unit vector array*/
131			vector<RealType> zAngle; /** z-angle array */
132			vector<Vector3d> force; /** force array */
133			vector<Vector3d> torque; /** torque array */
134			vector<RealType> particlePot; /** particle potential arrray */
135			vector<RealType> density; /** electron density */
136			vector<RealType> functional; /** density functional */
137			vector<RealType> functionalDerivative; /** derivative of functional */
138			vector<Vector3d> electricField; /** local electric field */
139			vector<RealType> skippedCharge; /** charge skipped during normal pairwise calculation */
140			vector<RealType> flucQPos; /** fluctuating charges */
141			vector<RealType> flucQVel; /** fluctuating charge velocities */
142			vector<RealType> flucQFrc; /** fluctuating charge forces */
143	gezelter	246
144	gezelter	507	static int getBytesPerStuntDouble(int layout);
145	tim	323
146	gezelter	507	private:
147	tim	155
148	gezelter	1710	RealType* internalGetArrayPointer(vector<Vector3d>& v);
149			RealType* internalGetArrayPointer(vector<RotMat3x3d>& v);
150			RealType* internalGetArrayPointer(vector<RealType>& v);
151	gezelter	1104
152	tim	155
153	gezelter	507	template<typename T>
154			void internalResize(std::vector<T>& v, int newSize);
155	tim	155
156	gezelter	507	template<typename T>
157			void internalCopy(std::vector<T>& v, int source, int num, int target);
158	tim	155
159	gezelter	507	int size_;
160			int storageLayout_;
161	gezelter	246
162	gezelter	507	};
163	tim	155
164	tim	323	}
165	tim	155	#endif //BRAINS_DATASTORAGE_HPP