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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */
 
/**
 * @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>

namespace oopse {
  /**
   * @class DataStorage
   * @warning do not try to insert element into (or ease element from) private member data 
   * of DataStorage directly.
   * @todo DataStorage may need refactorying. Every std::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
    };


    DataStorage();
    DataStorage(int size, int storageLayout = 255);
    /** 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 std::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 call std::copy for every std::vector in DataStorage class. 
     * One Precondition of std::copy is that target is not within the range [soruce, soruce + num]
     * @param souce 
     * @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 */
    double *getArrayPointer(int whichArray);

    std::vector<Vector3d> position;               /** position array */
    std::vector<Vector3d> velocity;               /** velocity array */
    std::vector<RotMat3x3d> aMat;            /** rotation matrix array */
    std::vector<Vector3d> angularMomentum;/** angular momentum array (body-fixed) */
    std::vector<Mat3x3d> electroFrame;                /** the lab frame unit std::vector array*/
    std::vector<double> zAngle;              /** z -angle array */        
    std::vector<Vector3d> force;               /** force array */
    std::vector<Vector3d> torque;               /** torque array */

    static int getBytesPerStuntDouble(int layout);

  private:

    double* internalGetArrayPointer(std::vector<Vector3d>& v);
            
    double* internalGetArrayPointer(std::vector<RotMat3x3d>& v);
    double* internalGetArrayPointer(std::vector<double>& 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:	2204
Committed:	Fri Apr 15 22:04:00 2005 UTC (19 years, 2 months ago) by gezelter
File size:	5221 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	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. Acknowledgement of the program authors must be made in any
10	* publication of scientific results based in part on use of the
11	* program. An acceptable form of acknowledgement is citation of
12	* the article in which the program was described (Matthew
13	* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14	* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15	* Parallel Simulation Engine for Molecular Dynamics,"
16	* J. Comput. Chem. 26, pp. 252-271 (2005))
17	*
18	* 2. Redistributions of source code must retain the above copyright
19	* notice, this list of conditions and the following disclaimer.
20	*
21	* 3. Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the
24	* distribution.
25	*
26	* This software is provided "AS IS," without a warranty of any
27	* kind. All express or implied conditions, representations and
28	* warranties, including any implied warranty of merchantability,
29	* fitness for a particular purpose or non-infringement, are hereby
30	* excluded. The University of Notre Dame and its licensors shall not
31	* be liable for any damages suffered by licensee as a result of
32	* using, modifying or distributing the software or its
33	* derivatives. In no event will the University of Notre Dame or its
34	* licensors be liable for any lost revenue, profit or data, or for
35	* direct, indirect, special, consequential, incidental or punitive
36	* damages, however caused and regardless of the theory of liability,
37	* arising out of the use of or inability to use software, even if the
38	* University of Notre Dame has been advised of the possibility of
39	* such damages.
40	*/
41
42	/**
43	* @file Vector.hpp
44	* @author Teng Lin
45	* @date 09/14/2004
46	* @version 1.0
47	*/
48
49	#ifndef BRAINS_DATASTORAGE_HPP
50	#define BRAINS_DATASTORAGE_HPP
51
52	#include <vector>
53	#include <math/Vector3.hpp>
54	#include <math/SquareMatrix3.hpp>
55
56	namespace oopse {
57	/**
58	* @class DataStorage
59	* @warning do not try to insert element into (or ease element from) private member data
60	* of DataStorage directly.
61	* @todo DataStorage may need refactorying. Every std::vector can inherit from the same base class
62	* which will make it easy to maintain
63	*/
64	class DataStorage {
65	public:
66
67	enum{
68	dslPosition = 1,
69	dslVelocity = 2,
70	dslAmat = 4,
71	dslAngularMomentum = 8,
72	dslElectroFrame = 16,
73	dslZAngle = 32,
74	dslForce = 64,
75	dslTorque = 128
76	};
77
78
79	DataStorage();
80	DataStorage(int size, int storageLayout = 255);
81	/** return the size of this DataStorage. */
82	int getSize();
83	/**
84	* Changes the size of this DataStorage.
85	* @param size new size of this DataStorage
86	*/
87	void resize(int newSize);
88	/**
89	* Reallocates memory manually. The main reason for using reserve() is efficiency
90	* if you know the capacity to which your std::vector must eventually grow, then it is usually more
91	* efficient to allocate that memory all at once.
92	*/
93	void reserve(int size);
94	/**
95	* Copies data inside DataStorage class.
96	* Copy function actually call std::copy for every std::vector in DataStorage class.
97	* One Precondition of std::copy is that target is not within the range [soruce, soruce + num]
98	* @param souce
99	* @param num number of element to be moved
100	* @param target
101	*/
102	void copy(int source, int num, int target);
103	/** Returns the storage layout */
104	int getStorageLayout();
105	/** Sets the storage layout */
106	void setStorageLayout(int layout);
107	/** Returns the pointer of internal array */
108	double *getArrayPointer(int whichArray);
109
110	std::vector<Vector3d> position; /** position array */
111	std::vector<Vector3d> velocity; /** velocity array */
112	std::vector<RotMat3x3d> aMat; /** rotation matrix array */
113	std::vector<Vector3d> angularMomentum;/** angular momentum array (body-fixed) */
114	std::vector<Mat3x3d> electroFrame; /** the lab frame unit std::vector array*/
115	std::vector<double> zAngle; /** z -angle array */
116	std::vector<Vector3d> force; /** force array */
117	std::vector<Vector3d> torque; /** torque array */
118
119	static int getBytesPerStuntDouble(int layout);
120
121	private:
122
123	double* internalGetArrayPointer(std::vector<Vector3d>& v);
124
125	double* internalGetArrayPointer(std::vector<RotMat3x3d>& v);
126	double* internalGetArrayPointer(std::vector<double>& v);
127
128	template<typename T>
129	void internalResize(std::vector<T>& v, int newSize);
130
131	template<typename T>
132	void internalCopy(std::vector<T>& v, int source, int num, int target);
133
134	int size_;
135	int storageLayout_;
136
137	};
138
139	}
140	#endif //BRAINS_DATASTORAGE_HPP