ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/OpenMD/branches/development/src/brains/Snapshot.hpp

Comparing:
trunk/src/brains/Snapshot.hpp (file contents), Revision 152 by tim, Tue Oct 26 17:28:53 2004 UTC vs.
branches/development/src/brains/Snapshot.hpp (file contents), Revision 1562 by gezelter, Thu May 12 17:00:14 2011 UTC

#	Line 1 | Line 1
1		/*
2	<	* Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
3	<	*
4	<	* Contact: oopse@oopse.org
5	<	*
6	<	* This program is free software; you can redistribute it and/or
7	<	* modify it under the terms of the GNU Lesser General Public License
8	<	* as published by the Free Software Foundation; either version 2.1
9	<	* of the License, or (at your option) any later version.
10	<	* All we ask is that proper credit is given for our work, which includes
11	<	* - but is not limited to - adding the above copyright notice to the beginning
12	<	* of your source code files, and to any copyright notice that you may distribute
13	<	* with programs based on this work.
14	<	*
15	<	* This program is distributed in the hope that it will be useful,
16	<	* but WITHOUT ANY WARRANTY; without even the implied warranty of
17	<	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18	<	* GNU Lesser General Public License for more details.
19	<	*
20	<	* You should have received a copy of the GNU Lesser General Public License
21	<	* along with this program; if not, write to the Free Software
22	<	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
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		*/
25	–
26	–	/**
27	–	* @file Snapshot.hpp
28	–	* @author tlin
29	–	* @date 10/20/2004
30	–	* @time 23:56am
31	–	* @version 1.0
32	–	*/
41
42	+	/**
43	+	* @file Snapshot.hpp
44	+	* @author tlin
45	+	* @date 10/20/2004
46	+	* @time 23:56am
47	+	* @version 1.0
48	+	*/
49	+
50		#ifndef BRAINS_SNAPSHOT_HPP
51		#define BRAINS_SNAPSHOT_HPP
52
53		#include <vector>
54
55	<	#include "math/Vector3.hpp"
56	<	#include "math/SquareMatrix3.hpp"
55	>	#include "brains/DataStorage.hpp"
56	>	#include "brains/Stats.hpp"
57
58	<	using namespace std;
58	>	namespace OpenMD{
59
60	<	namespace oopse{
60	>	/**
61	>	* @class Snapshot Snapshot.hpp "brains/Snapshot.hpp"
62	>	* @brief Snapshot class is a repository class for storing dynamic data during
63	>	*  Simulation
64	>	* Every snapshot class will contain one DataStorage for atoms and one DataStorage
65	>	*  for rigid bodies.
66	>	*/
67	>	class Snapshot {
68	>	public:
69	>
70	>	Snapshot(int nAtoms, int nRigidbodies,
71	>	int nCutoffGroups) : atomData(nAtoms),
72	>	rigidbodyData(nRigidbodies),
73	>	cgData(nCutoffGroups, DataStorage::dslPosition),
74	>	currentTime_(0),
75	>	orthoTolerance_(1e-6),
76	>	orthoRhombic_(0),
77	>	chi_(0.0),
78	>	integralOfChiDt_(0.0),
79	>	eta_(0.0), id_(-1), hasCOM_(false),
80	>	hasVolume_(false), volume_(0.0) {
81
82	+	}
83
84	<	//forward declaration
85	<	class Snapshot;
86	<	class SnapshotManager;
87	<	class StuntDouble;
84	>	Snapshot(int nAtoms, int nRigidbodies, int nCutoffGroups,
85	>	int storageLayout) : atomData(nAtoms, storageLayout),
86	>	rigidbodyData(nRigidbodies, storageLayout),
87	>	cgData(nCutoffGroups, DataStorage::dslPosition),
88	>	currentTime_(0), orthoTolerance_(1e-6),
89	>	orthoRhombic_(0), chi_(0.0),
90	>	integralOfChiDt_(0.0), eta_(0.0), id_(-1),
91	>	hasCOM_(false), hasVolume_(false),
92	>	volume_(0.0)  {
93	>	}
94
95	<	/**
96	<	* @class DataStorage
97	<	* @warning do not try to insert element into (or ease element from) private member data
98	<	* of DataStorage directly.
56	<	*/
57	<	class DataStorage {
58	<	public:
95	>	/** Returns the id of this Snapshot */
96	>	int getID() {
97	>	return id_;
98	>	}
99
100	<	enum{
101	<	slPosition = 1,
102	<	slVelocity = 2,
103	<	slAmat = 4,
64	<	slAngularMomentum = 8,
65	<	slUnitVector = 16,
66	<	slZAngle = 32,
67	<	slForce = 64,
68	<	slTorque = 128
69	<	};
70	<
71	<	DataStorage(int size);
100	>	/** Sets the id of this Snapshot */
101	>	void setID(int id) {
102	>	id_ = id;
103	>	}
104
105	<	/** return the size of this DataStorage */
106	<	int size();
107	<	void resize(int size);
76	<	void reserve(int size);
105	>	int getSize() {
106	>	return atomData.getSize() + rigidbodyData.getSize();
107	>	}
108
109	<	void move(int source, int num, int target);
110	<	int getStorageLayout();
111	<	void setStorageLayout(int layout);
109	>	/** Returns the number of atoms */
110	>	int getNumberOfAtoms() {
111	>	return atomData.getSize();
112	>	}
113
114	<	double *getArrayPointer(int );
114	>	/** Returns the number of rigid bodies */
115	>	int getNumberOfRigidBodies() {
116	>	return rigidbodyData.getSize();
117	>	}
118
119	<	friend class StuntDouble;
119	>	/** Returns the number of rigid bodies */
120	>	int getNumberOfCutoffGroups() {
121	>	return cgData.getSize();
122	>	}
123
124	<	private:
125	<	int size_;
126	<	int storageLayout_;
127	<	vector<Vector3d> position;               /** position array */
90	<	vector<Vector3d> velocity;               /** velocity array */
91	<	vector<RotMat3x3d> aMat;            /** rotation matrix array */
92	<	vector<Vector3d> angularMomentum;/** velocity array */
93	<	vector<Vector3d> unitVector;                /** the lab frame unit vector array*/
94	<	vector<double> zAngle;              /** z -angle array */
95	<	vector<Vector3d> force;               /** force array */
96	<	vector<Vector3d> torque;               /** torque array */
97	<	};
124	>	/** Returns the H-Matrix */
125	>	Mat3x3d getHmat() {
126	>	return hmat_;
127	>	}
128
129	<	/**
130	<	* @class Snapshot Snapshot.hpp "brains/Snapshot.hpp"
101	<	* @brief Snapshot class is a repository class for storing dynamic data during
102	<	*  Simulation
103	<	* Every snapshot class will contain one DataStorage  for atoms and one DataStorage
104	<	*  for rigid bodies.
105	<	* @see SimData
106	<	*/
107	<	class Snapshot {
108	<	public:
129	>	/** Sets the H-Matrix */
130	>	void setHmat(const Mat3x3d& m);
131
132	<	Snapshot(int nAtoms, int nRigidbodies) {
133	<	atomData.resize(nAtoms);
134	<	rigidbodyData.resize(nRigidbodies);
135	<	}
132	>	RealType getVolume() {
133	>	if (hasVolume_){
134	>	return volume_;
135	>	}else{
136	>	return hmat_.determinant();
137	>	}
138	>	}
139
140	<	Snapshot(const Snapshot& s);
140	>	void setVolume(RealType volume){
141	>	hasVolume_=true;
142	>	volume_ = volume;
143	>	}
144
145	<	Snapshot& operator =(const Snapshot& s);
145	>	/** Returns the inverse H-Matrix */
146	>	Mat3x3d getInvHmat() {
147	>	return invHmat_;
148	>	}
149	>
150	>	/** Wrapping the vector according to periodic boundary condition*/
151	>	void wrapVector(Vector3d& v);
152	>	/** Scaling a vector to multiples of the periodic box */
153	>	Vector3d scaleVector(Vector3d &v);
154	>
155	>
156	>	Vector3d getCOM();
157	>	Vector3d getCOMvel();
158	>	Vector3d getCOMw();
159
160	<	/** Returns the id of this Snapshot */
161	<	int getID() {
162	<	return id_;
122	<	}
160	>	RealType getTime() {
161	>	return currentTime_;
162	>	}
163
164	<	/** Sets the id of this Snapshot */
165	<	void setID(int id) {
166	<	id_ = id;
127	<	}
164	>	void increaseTime(RealType dt) {
165	>	setTime(getTime() + dt);
166	>	}
167
168	<	//template<typename T>
169	<	//static typename T::ElemPointerType getArrayPointer(vector<T>& v) {
170	<	//    return v[0]->getArrayPointer();
171	<	//}
168	>	void setTime(RealType time) {
169	>	currentTime_ =time;
170	>	//time at statData is redundant
171	>	statData[Stats::TIME] = currentTime_;
172	>	}
173
174	<	int getSize() {
175	<	return atomData.size() + rigidbodyData.size();
176	<	}
174	>	RealType getChi() {
175	>	return chi_;
176	>	}
177
178	<	/** Returns the number of atoms */
179	<	int getNumberOfAtoms() {
180	<	return atomData.size();
141	<	}
178	>	void setChi(RealType chi) {
179	>	chi_ = chi;
180	>	}
181
182	<	/** Returns the number of rigid bodies */
183	<	int getNumberOfRigidBodies() {
184	<	return rigidbodyData.size();
146	<	}
182	>	RealType getIntegralOfChiDt() {
183	>	return integralOfChiDt_;
184	>	}
185
186	<	/** Returns the H-Matrix */
187	<	Mat3x3d getHmat() {
188	<	return hmat_;
189	<	}
186	>	void setIntegralOfChiDt(RealType integralOfChiDt) {
187	>	integralOfChiDt_ = integralOfChiDt;
188	>	}
189	>
190
191	<	/** Sets the H-Matrix */
192	<	void setHamt(const Mat3x3d& m) {
193	<	hmat_ = m;
156	<	invHmat_ = hmat_.inverse();
157	<	}
191	>	void setOrthoTolerance(RealType orthoTolerance) {
192	>	orthoTolerance_ = orthoTolerance;
193	>	}
194
195	<	/** Returns the inverse H-Matrix */
196	<	Mat3x3d getInvHmat() {
197	<	return invHmat_
162	<	}
195	>	Mat3x3d getEta() {
196	>	return eta_;
197	>	}
198
199	<	double getTimeStamp() {
200	<	return timeStamp_;
201	<	}
199	>	void setEta(const Mat3x3d& eta) {
200	>	eta_ = eta;
201	>	}
202
203	<	void setTimeStamp(double timeStamp) {
204	<	timeStamp_ =timeStamp;
205	<	}
203	>	bool hasCOM() {
204	>	return hasCOM_;
205	>	}
206
207	+	void setCOMprops(const Vector3d& COM, const Vector3d& COMvel, const Vector3d& COMw) {
208	+	COM_ = COM;
209	+	COMvel_ = COMvel;
210	+	COMw_ = COMw;
211	+	hasCOM_ = true;
212	+	}
213
214	<	DataStorage atomData;
215	<	DataStorage rigidbodyData;
214	>	DataStorage atomData;
215	>	DataStorage rigidbodyData;
216	>	DataStorage cgData;
217	>	Stats statData;
218	>
219	>	private:
220	>	RealType currentTime_;
221	>
222	>	Mat3x3d hmat_;
223	>	Mat3x3d invHmat_;
224	>	RealType orthoTolerance_;
225	>	int orthoRhombic_;
226	>	RealType volume_;
227	>
228	>	RealType chi_;
229	>	RealType integralOfChiDt_;
230	>	Mat3x3d eta_;
231	>	Vector3d COM_;
232	>	Vector3d COMvel_;
233	>	Vector3d COMw_;
234	>	int id_; /**< identification number of the snapshot */
235	>	bool hasCOM_;
236	>	bool hasVolume_;
237
238	<	friend class StuntDouble;
177	<
178	<	private:
179	<	double timeStamp_;
180	<	Mat3x3d hmat_;
181	<	Mat3x3d invHmat_;
182	<	int id_; /**< identification number of the snapshot */
183	<	};
238	>	};
239
240	<	typedef DataStorage (Snapshot::*DataStoragePointer);
240	>	typedef DataStorage (Snapshot::*DataStoragePointer);
241		}
242		#endif //BRAINS_SNAPSHOT_HPP

Comparing:
trunk/src/brains/Snapshot.hpp (property svn:keywords), Revision 152 by tim, Tue Oct 26 17:28:53 2004 UTC vs.
branches/development/src/brains/Snapshot.hpp (property svn:keywords), Revision 1562 by gezelter, Thu May 12 17:00:14 2011 UTC

#	Line 0 | Line 1
1	+	Author Id Revision Date

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines