ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/src/primitives/Molecule.hpp
Revision: 1275
Committed: Fri Jul 4 20:54:29 2008 UTC (16 years, 10 months ago) by cli2
File size: 10967 byte(s)
Log Message:
Changes required for Inversions and Base Atom types.  This will
break OOPSE badly for a few days or so...

File Contents

# User Rev Content
1 gezelter 507 /*
2 gezelter 246 * 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 Molecule.hpp
44     * @author tlin
45     * @date 10/25/2004
46     * @version 1.0
47     */
48 gezelter 2
49 gezelter 246 #ifndef PRIMITIVES_MOLECULE_HPP
50     #define PRIMITIVES_MOLECULE_HPP
51 gezelter 2 #include <vector>
52 gezelter 246 #include <iostream>
53 gezelter 2
54 gezelter 246 #include "constraints/ConstraintPair.hpp"
55     #include "math/Vector3.hpp"
56 tim 3 #include "primitives/Atom.hpp"
57     #include "primitives/RigidBody.hpp"
58 gezelter 246 #include "primitives/Bond.hpp"
59     #include "primitives/Bend.hpp"
60     #include "primitives/Torsion.hpp"
61 cli2 1275 #include "primitives/Inversion.hpp"
62 tim 3 #include "primitives/CutoffGroup.hpp"
63 gezelter 2
64 gezelter 246 namespace oopse{
65 gezelter 2
66 gezelter 507 class Constraint;
67 gezelter 2
68 gezelter 507 /**
69     * @class Molecule Molecule.hpp "primitives/Molecule.hpp"
70     * @brief
71     */
72     class Molecule {
73     public:
74 gezelter 2
75 gezelter 507 typedef std::vector<Atom*>::iterator AtomIterator;
76     typedef std::vector<Bond*>::iterator BondIterator;
77     typedef std::vector<Bend*>::iterator BendIterator;
78     typedef std::vector<Torsion*>::iterator TorsionIterator;
79 cli2 1275 typedef std::vector<Inversion*>::iterator InversionIterator;
80 gezelter 507 typedef std::vector<RigidBody*>::iterator RigidBodyIterator;
81     typedef std::vector<CutoffGroup*>::iterator CutoffGroupIterator;
82 gezelter 1211 typedef std::vector<StuntDouble*>::iterator IntegrableObjectIterator;
83 gezelter 507 typedef std::vector<ConstraintPair*>::iterator ConstraintPairIterator;
84     typedef std::vector<ConstraintElem*>::iterator ConstraintElemIterator;
85 gezelter 1211
86    
87 gezelter 507 Molecule(int stampId, int globalIndex, const std::string& molName);
88     virtual ~Molecule();
89 gezelter 1211
90 gezelter 507 /**
91     * Returns the global index of this molecule.
92     * @return the global index of this molecule
93     */
94     int getGlobalIndex() {
95     return globalIndex_;
96     }
97 gezelter 1211
98 gezelter 507 /**
99     * Returns the stamp id of this molecule
100 gezelter 1211 * @note Ideally, every molecule should keep a pointer of its
101     * molecule stamp instead of its stamp id. However, the pointer
102     * will become invalid, if the molecule migrate to other
103     * processor.
104 gezelter 507 */
105     int getStampId() {
106     return stampId_;
107     }
108 gezelter 1211
109 gezelter 507 /** Returns the name of the molecule */
110     std::string getType() {
111     return moleculeName_;
112     }
113 gezelter 1211
114 gezelter 507 /**
115     * Sets the global index of this molecule.
116     * @param new global index to be set
117     */
118     void setGlobalIndex(int index) {
119     globalIndex_ = index;
120     }
121 gezelter 1211
122    
123 gezelter 507 /** add an atom into this molecule */
124     void addAtom(Atom* atom);
125 gezelter 1211
126 gezelter 507 /** add a bond into this molecule */
127     void addBond(Bond* bond);
128 gezelter 1211
129 gezelter 507 /** add a bend into this molecule */
130     void addBend(Bend* bend);
131 gezelter 1211
132 gezelter 507 /** add a torsion into this molecule*/
133     void addTorsion(Torsion* torsion);
134 cli2 1275
135     /** add an improper torsion into this molecule*/
136     void addInversion(Inversion* inversion);
137 gezelter 1211
138 gezelter 507 /** add a rigidbody into this molecule */
139     void addRigidBody(RigidBody *rb);
140 gezelter 1211
141 gezelter 507 /** add a cutoff group into this molecule */
142     void addCutoffGroup(CutoffGroup* cp);
143 gezelter 1211
144 gezelter 507 void addConstraintPair(ConstraintPair* consPair);
145 gezelter 1211
146 gezelter 507 void addConstraintElem(ConstraintElem* consElem);
147 gezelter 1211
148 gezelter 507 /** */
149     void complete();
150 gezelter 1211
151 gezelter 507 /** Returns the total number of atoms in this molecule */
152     unsigned int getNAtoms() {
153     return atoms_.size();
154     }
155 gezelter 1211
156 gezelter 507 /** Returns the total number of bonds in this molecule */
157     unsigned int getNBonds(){
158     return bonds_.size();
159     }
160 gezelter 1211
161 gezelter 507 /** Returns the total number of bends in this molecule */
162     unsigned int getNBends() {
163     return bends_.size();
164     }
165 gezelter 1211
166 gezelter 507 /** Returns the total number of torsions in this molecule */
167     unsigned int getNTorsions() {
168     return torsions_.size();
169     }
170 cli2 1275
171     /** Returns the total number of improper torsions in this molecule */
172     unsigned int getNInversions() {
173     return inversions_.size();
174     }
175 gezelter 1211
176 gezelter 507 /** Returns the total number of rigid bodies in this molecule */
177     unsigned int getNRigidBodies() {
178     return rigidBodies_.size();
179     }
180 gezelter 1211
181 gezelter 507 /** Returns the total number of integrable objects in this molecule */
182     unsigned int getNIntegrableObjects() {
183     return integrableObjects_.size();
184     }
185 gezelter 1211
186 gezelter 507 /** Returns the total number of cutoff groups in this molecule */
187     unsigned int getNCutoffGroups() {
188     return cutoffGroups_.size();
189     }
190 gezelter 1211
191 gezelter 507 /** Returns the total number of constraints in this molecule */
192     unsigned int getNConstraintPairs() {
193     return constraintPairs_.size();
194     }
195 gezelter 1211
196 gezelter 507 Atom* getAtomAt(unsigned int i) {
197     assert(i < atoms_.size());
198     return atoms_[i];
199     }
200 gezelter 1211
201 gezelter 507 RigidBody* getRigidBodyAt(unsigned int i) {
202     assert(i < rigidBodies_.size());
203     return rigidBodies_[i];
204     }
205 gezelter 1211
206 gezelter 507 Atom* beginAtom(std::vector<Atom*>::iterator& i) {
207     i = atoms_.begin();
208     return (i == atoms_.end()) ? NULL : *i;
209     }
210 gezelter 1211
211 gezelter 507 Atom* nextAtom(std::vector<Atom*>::iterator& i) {
212     ++i;
213     return (i == atoms_.end()) ? NULL : *i;
214     }
215 gezelter 1211
216 gezelter 507 Bond* beginBond(std::vector<Bond*>::iterator& i) {
217     i = bonds_.begin();
218     return (i == bonds_.end()) ? NULL : *i;
219     }
220 gezelter 1211
221 gezelter 507 Bond* nextBond(std::vector<Bond*>::iterator& i) {
222     ++i;
223     return (i == bonds_.end()) ? NULL : *i;
224 gezelter 1211
225 gezelter 507 }
226 gezelter 1211
227 gezelter 507 Bend* beginBend(std::vector<Bend*>::iterator& i) {
228     i = bends_.begin();
229     return (i == bends_.end()) ? NULL : *i;
230     }
231 gezelter 1211
232 gezelter 507 Bend* nextBend(std::vector<Bend*>::iterator& i) {
233     ++i;
234     return (i == bends_.end()) ? NULL : *i;
235     }
236 gezelter 1211
237 gezelter 507 Torsion* beginTorsion(std::vector<Torsion*>::iterator& i) {
238     i = torsions_.begin();
239     return (i == torsions_.end()) ? NULL : *i;
240     }
241 gezelter 1211
242 gezelter 507 Torsion* nextTorsion(std::vector<Torsion*>::iterator& i) {
243     ++i;
244     return (i == torsions_.end()) ? NULL : *i;
245     }
246 cli2 1275
247     Inversion* beginInversion(std::vector<Inversion*>::iterator& i) {
248     i = inversions_.begin();
249     return (i == inversions_.end()) ? NULL : *i;
250     }
251 gezelter 1211
252 cli2 1275 Inversion* nextInversion(std::vector<Inversion*>::iterator& i) {
253     ++i;
254     return (i == inversions_.end()) ? NULL : *i;
255     }
256    
257 gezelter 507 RigidBody* beginRigidBody(std::vector<RigidBody*>::iterator& i) {
258     i = rigidBodies_.begin();
259     return (i == rigidBodies_.end()) ? NULL : *i;
260     }
261 gezelter 1211
262 gezelter 507 RigidBody* nextRigidBody(std::vector<RigidBody*>::iterator& i) {
263     ++i;
264     return (i == rigidBodies_.end()) ? NULL : *i;
265     }
266 gezelter 1211
267 gezelter 507 StuntDouble* beginIntegrableObject(std::vector<StuntDouble*>::iterator& i) {
268     i = integrableObjects_.begin();
269     return (i == integrableObjects_.end()) ? NULL : *i;
270     }
271 gezelter 1211
272 gezelter 507 StuntDouble* nextIntegrableObject(std::vector<StuntDouble*>::iterator& i) {
273     ++i;
274     return (i == integrableObjects_.end()) ? NULL : *i;
275     }
276 gezelter 1211
277 gezelter 507 CutoffGroup* beginCutoffGroup(std::vector<CutoffGroup*>::iterator& i) {
278     i = cutoffGroups_.begin();
279     return (i == cutoffGroups_.end()) ? NULL : *i;
280     }
281 gezelter 246
282 gezelter 1211 CutoffGroup* nextCutoffGroup(std::vector<CutoffGroup*>::iterator& i) {
283 gezelter 507 ++i;
284     return (i == cutoffGroups_.end()) ? NULL : *i;
285     }
286 gezelter 1211
287 gezelter 507 ConstraintPair* beginConstraintPair(std::vector<ConstraintPair*>::iterator& i) {
288     i = constraintPairs_.begin();
289     return (i == constraintPairs_.end()) ? NULL : *i;
290     }
291 gezelter 1211
292 gezelter 507 ConstraintPair* nextConstraintPair(std::vector<ConstraintPair*>::iterator& i) {
293     ++i;
294     return (i == constraintPairs_.end()) ? NULL : *i;
295     }
296 gezelter 1211
297 gezelter 507 ConstraintElem* beginConstraintElem(std::vector<ConstraintElem*>::iterator& i) {
298     i = constraintElems_.begin();
299     return (i == constraintElems_.end()) ? NULL : *i;
300     }
301 gezelter 1211
302 gezelter 507 ConstraintElem* nextConstraintElem(std::vector<ConstraintElem*>::iterator& i) {
303     ++i;
304     return (i == constraintElems_.end()) ? NULL : *i;
305     }
306 gezelter 1211
307     /**
308     * Returns the total potential energy of short range interaction
309     * of this molecule
310     */
311 tim 963 RealType getPotential();
312 gezelter 1211
313 gezelter 507 /** get total mass of this molecule */
314 tim 963 RealType getMass();
315 gezelter 1211
316 gezelter 507 /** return the center of mass of this molecule */
317     Vector3d getCom();
318 gezelter 1211
319 gezelter 507 /** Moves the center of this molecule */
320     void moveCom(const Vector3d& delta);
321 gezelter 1211
322 gezelter 507 /** Returns the velocity of center of mass of this molecule */
323     Vector3d getComVel();
324 gezelter 246
325 gezelter 507 std::string getMoleculeName() {
326     return moleculeName_;
327     }
328 tim 289
329 gezelter 507 friend std::ostream& operator <<(std::ostream& o, Molecule& mol);
330 gezelter 1211
331 gezelter 507 private:
332 gezelter 1211
333 gezelter 507 int globalIndex_;
334 gezelter 1211
335 gezelter 507 std::vector<Atom*> atoms_;
336     std::vector<Bond*> bonds_;
337     std::vector<Bend*> bends_;
338     std::vector<Torsion*> torsions_;
339 cli2 1275 std::vector<Inversion*> inversions_;
340 gezelter 507 std::vector<RigidBody*> rigidBodies_;
341     std::vector<StuntDouble*> integrableObjects_;
342     std::vector<CutoffGroup*> cutoffGroups_;
343     std::vector<ConstraintPair*> constraintPairs_;
344     std::vector<ConstraintElem*> constraintElems_;
345     int stampId_;
346     std::string moleculeName_;
347     };
348 gezelter 2
349 gezelter 246 } //namespace oopse
350     #endif //