ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/src/primitives/Molecule.hpp
(Generate patch)

Comparing trunk/src/primitives/Molecule.hpp (file contents):
Revision 2 by gezelter, Fri Sep 24 04:16:43 2004 UTC vs.
Revision 1275 by cli2, Fri Jul 4 20:54:29 2008 UTC

# Line 1 | Line 1
1 < #ifndef _MOLECULE_H_
2 < #define _MOLECULE_H_
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 Molecule.hpp
44 > * @author    tlin
45 > * @date  10/25/2004
46 > * @version 1.0
47 > */
48  
49 < #include <set>
49 > #ifndef PRIMITIVES_MOLECULE_HPP
50 > #define PRIMITIVES_MOLECULE_HPP
51   #include <vector>
52 + #include <iostream>
53  
54 < #include "Atom.hpp"
55 < #include "SRI.hpp"
56 < #include "MoleculeStamp.hpp"
57 < #include "RigidBody.hpp"
58 < #include "CutoffGroup.hpp"
54 > #include "constraints/ConstraintPair.hpp"
55 > #include "math/Vector3.hpp"
56 > #include "primitives/Atom.hpp"
57 > #include "primitives/RigidBody.hpp"
58 > #include "primitives/Bond.hpp"
59 > #include "primitives/Bend.hpp"
60 > #include "primitives/Torsion.hpp"
61 > #include "primitives/Inversion.hpp"
62 > #include "primitives/CutoffGroup.hpp"
63  
64 < using namespace std;
64 > namespace oopse{
65  
66 < typedef struct{
16 <  
17 <  int stampID;   // the ID in the BASS component stamp array
18 <  int nAtoms;    // the number of atoms in the molecule
19 <  int nBonds;    // ... .. ..  . .bonds .. .. . . . .
20 <  int nBends;    // . . . . .. . .bends . . . . .. .
21 <  int nTorsions; // .. . . .. . . torsions . . .. . .
22 <  int nRigidBodies; // .. .. .. . rigid bodies ... ..
23 <  int nOriented; // .. . . . .. . oriented atoms . . .
24 <  
25 <  Atom** myAtoms;      // the array of atoms
26 <  Bond** myBonds;      // arrays of all the short range interactions
27 <  Bend** myBends;
28 <  Torsion** myTorsions;
29 <  vector<RigidBody*>   myRigidBodies;
30 <  vector<StuntDouble*> myIntegrableObjects;
31 <  vector<CutoffGroup*> myCutoffGroups;
32 < } molInit;
66 >  class Constraint;
67  
68 < class Molecule{
68 >  /**
69 >   * @class Molecule Molecule.hpp "primitives/Molecule.hpp"
70 >   * @brief
71 >   */
72 >  class Molecule {
73 >  public:
74  
75 < public:
76 <  
77 <  Molecule( void );
78 <  ~Molecule( void );
75 >    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 >    typedef std::vector<Inversion*>::iterator InversionIterator;
80 >    typedef std::vector<RigidBody*>::iterator RigidBodyIterator;
81 >    typedef std::vector<CutoffGroup*>::iterator CutoffGroupIterator;
82 >    typedef std::vector<StuntDouble*>::iterator IntegrableObjectIterator;
83 >    typedef std::vector<ConstraintPair*>::iterator ConstraintPairIterator;
84 >    typedef std::vector<ConstraintElem*>::iterator ConstraintElemIterator;
85 >    
86 >    
87 >    Molecule(int stampId, int globalIndex, const std::string& molName);
88 >    virtual ~Molecule();
89 >    
90 >    /**
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 >    
98 >    /**
99 >     * Returns the stamp id of this molecule
100 >     * @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 >     */
105 >    int getStampId() {
106 >      return stampId_;
107 >    }
108 >    
109 >    /** Returns the name of the molecule */
110 >    std::string getType() {
111 >      return moleculeName_;
112 >    }
113 >    
114 >    /**
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 >    
122 >    
123 >    /** add an atom into this molecule */
124 >    void addAtom(Atom* atom);
125 >    
126 >    /** add a bond into this molecule */
127 >    void addBond(Bond* bond);
128 >    
129 >    /** add a bend into this molecule */
130 >    void addBend(Bend* bend);
131 >    
132 >    /** add a torsion into this molecule*/
133 >    void addTorsion(Torsion* torsion);
134  
135 <  void initialize( molInit &theInit );
135 >    /** add an improper torsion into this molecule*/
136 >    void addInversion(Inversion* inversion);
137 >    
138 >    /** add a rigidbody into this molecule */
139 >    void addRigidBody(RigidBody *rb);
140 >    
141 >    /** add a cutoff group into this molecule */
142 >    void addCutoffGroup(CutoffGroup* cp);    
143 >    
144 >    void addConstraintPair(ConstraintPair* consPair);
145 >    
146 >    void addConstraintElem(ConstraintElem* consElem);
147 >    
148 >    /** */
149 >    void complete();
150 >    
151 >    /** Returns the total number of atoms in this molecule */
152 >    unsigned int getNAtoms() {
153 >      return atoms_.size();
154 >    }
155 >    
156 >    /** Returns the total number of bonds in this molecule */        
157 >    unsigned int getNBonds(){
158 >      return bonds_.size();
159 >    }
160 >    
161 >    /** Returns the total number of bends in this molecule */        
162 >    unsigned int getNBends() {
163 >      return bends_.size();
164 >    }
165 >    
166 >    /** Returns the total number of torsions in this molecule */        
167 >    unsigned int getNTorsions() {
168 >      return torsions_.size();
169 >    }
170  
171 <  void setMyIndex( int theIndex ){ myIndex = theIndex;}
172 <  int getMyIndex( void ) { return myIndex; }
171 >    /** Returns the total number of improper torsions in this molecule */
172 >    unsigned int getNInversions() {
173 >      return inversions_.size();
174 >    }
175 >    
176 >    /** Returns the total number of rigid bodies in this molecule */        
177 >    unsigned int getNRigidBodies() {
178 >      return rigidBodies_.size();
179 >    }
180 >    
181 >    /** Returns the total number of integrable objects in this molecule */
182 >    unsigned int getNIntegrableObjects() {
183 >      return integrableObjects_.size();
184 >    }
185 >    
186 >    /** Returns the total number of cutoff groups in this molecule */
187 >    unsigned int getNCutoffGroups() {
188 >      return cutoffGroups_.size();
189 >    }
190 >    
191 >    /** Returns the total number of constraints in this molecule */
192 >    unsigned int getNConstraintPairs() {
193 >      return constraintPairs_.size();
194 >    }
195 >    
196 >    Atom* getAtomAt(unsigned int i) {
197 >      assert(i < atoms_.size());
198 >      return atoms_[i];
199 >    }
200 >    
201 >    RigidBody* getRigidBodyAt(unsigned int i) {
202 >      assert(i < rigidBodies_.size());
203 >      return rigidBodies_[i];
204 >    }
205 >    
206 >    Atom* beginAtom(std::vector<Atom*>::iterator& i) {
207 >      i = atoms_.begin();
208 >      return (i == atoms_.end()) ? NULL : *i;
209 >    }
210 >    
211 >    Atom* nextAtom(std::vector<Atom*>::iterator& i) {
212 >      ++i;
213 >      return (i == atoms_.end()) ? NULL : *i;    
214 >    }
215 >    
216 >    Bond* beginBond(std::vector<Bond*>::iterator& i) {
217 >      i = bonds_.begin();
218 >      return (i == bonds_.end()) ? NULL : *i;
219 >    }
220 >    
221 >    Bond* nextBond(std::vector<Bond*>::iterator& i) {
222 >      ++i;
223 >      return (i == bonds_.end()) ? NULL : *i;    
224 >      
225 >    }
226 >    
227 >    Bend* beginBend(std::vector<Bend*>::iterator& i) {
228 >      i = bends_.begin();
229 >      return (i == bends_.end()) ? NULL : *i;
230 >    }
231 >    
232 >    Bend* nextBend(std::vector<Bend*>::iterator& i) {
233 >      ++i;
234 >      return (i == bends_.end()) ? NULL : *i;    
235 >    }
236 >    
237 >    Torsion* beginTorsion(std::vector<Torsion*>::iterator& i) {
238 >      i = torsions_.begin();
239 >      return (i == torsions_.end()) ? NULL : *i;
240 >    }
241 >    
242 >    Torsion* nextTorsion(std::vector<Torsion*>::iterator& i) {
243 >      ++i;
244 >      return (i == torsions_.end()) ? NULL : *i;    
245 >    }    
246  
247 <  int getGlobalIndex( void ) { return globalIndex; }
248 <  void setGlobalIndex( int theIndex ) { globalIndex = theIndex; }
247 >    Inversion* beginInversion(std::vector<Inversion*>::iterator& i) {
248 >      i = inversions_.begin();
249 >      return (i == inversions_.end()) ? NULL : *i;
250 >    }
251 >    
252 >    Inversion* nextInversion(std::vector<Inversion*>::iterator& i) {
253 >      ++i;
254 >      return (i == inversions_.end()) ? NULL : *i;    
255 >    }    
256 >    
257 >    RigidBody* beginRigidBody(std::vector<RigidBody*>::iterator& i) {
258 >      i = rigidBodies_.begin();
259 >      return (i == rigidBodies_.end()) ? NULL : *i;
260 >    }
261 >    
262 >    RigidBody* nextRigidBody(std::vector<RigidBody*>::iterator& i) {
263 >      ++i;
264 >      return (i == rigidBodies_.end()) ? NULL : *i;    
265 >    }
266 >    
267 >    StuntDouble* beginIntegrableObject(std::vector<StuntDouble*>::iterator& i) {
268 >      i = integrableObjects_.begin();
269 >      return (i == integrableObjects_.end()) ? NULL : *i;
270 >    }
271 >    
272 >    StuntDouble* nextIntegrableObject(std::vector<StuntDouble*>::iterator& i) {
273 >      ++i;
274 >      return (i == integrableObjects_.end()) ? NULL : *i;    
275 >    }    
276 >    
277 >    CutoffGroup* beginCutoffGroup(std::vector<CutoffGroup*>::iterator& i) {
278 >      i = cutoffGroups_.begin();
279 >      return (i == cutoffGroups_.end()) ? NULL : *i;
280 >    }
281  
282 <  int getNAtoms   ( void )    {return nAtoms;}
283 <  int getNBonds   ( void )    {return nBonds;}
284 <  int getNBends   ( void )    {return nBends;}
285 <  int getNTorsions( void )    {return nTorsions;}
286 <  int getNRigidBodies( void ) {return myRigidBodies.size();}
287 <  int getNOriented( void )    {return nOriented;}
288 <  int getNMembers ( void )    {return nMembers;}
289 <  int getStampID  ( void )    {return stampID;}
282 >    CutoffGroup* nextCutoffGroup(std::vector<CutoffGroup*>::iterator& i) {
283 >      ++i;
284 >      return (i == cutoffGroups_.end()) ? NULL : *i;    
285 >    }
286 >    
287 >    ConstraintPair* beginConstraintPair(std::vector<ConstraintPair*>::iterator& i) {
288 >      i = constraintPairs_.begin();
289 >      return (i == constraintPairs_.end()) ? NULL : *i;
290 >    }
291 >    
292 >    ConstraintPair* nextConstraintPair(std::vector<ConstraintPair*>::iterator& i) {            
293 >      ++i;
294 >      return (i == constraintPairs_.end()) ? NULL : *i;    
295 >    }        
296 >    
297 >    ConstraintElem* beginConstraintElem(std::vector<ConstraintElem*>::iterator& i) {
298 >      i = constraintElems_.begin();
299 >      return (i == constraintElems_.end()) ? NULL : *i;
300 >    }
301 >    
302 >    ConstraintElem* nextConstraintElem(std::vector<ConstraintElem*>::iterator& i) {            
303 >      ++i;
304 >      return (i == constraintElems_.end()) ? NULL : *i;    
305 >    }
306 >    
307 >    /**
308 >     * Returns the total potential energy of short range interaction
309 >     * of this molecule
310 >     */    
311 >    RealType getPotential();
312 >    
313 >    /** get total mass of this molecule */        
314 >    RealType getMass();
315 >    
316 >    /** return the center of mass of this molecule */
317 >    Vector3d getCom();
318 >    
319 >    /** Moves the center of this molecule */
320 >    void moveCom(const Vector3d& delta);
321 >    
322 >    /** Returns the velocity of center of mass of this molecule */
323 >    Vector3d getComVel();
324  
325 <  Atom**      getMyAtoms   ( void )    {return myAtoms;}
326 <  Bond**      getMyBonds   ( void )    {return myBonds;}
327 <  Bend**      getMyBends   ( void )    {return myBends;}
328 <  Torsion**   getMyTorsions( void )    {return myTorsions;}
329 <  vector<RigidBody*> getMyRigidBodies( void ) {return myRigidBodies;}
330 <  vector<StuntDouble*>& getIntegrableObjects(void) {return myIntegrableObjects;}
325 >    std::string getMoleculeName() {
326 >      return moleculeName_;
327 >    }
328 >        
329 >    friend std::ostream& operator <<(std::ostream& o, Molecule& mol);
330 >    
331 >  private:
332 >    
333 >    int globalIndex_;
334 >    
335 >    std::vector<Atom*> atoms_;
336 >    std::vector<Bond*> bonds_;
337 >    std::vector<Bend*> bends_;
338 >    std::vector<Torsion*> torsions_;
339 >    std::vector<Inversion*> inversions_;
340 >    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  
349 <  //beginCutoffGroup return the first group and initialize the iterator
350 <  CutoffGroup* beginCutoffGroup(vector<CutoffGroup*>::iterator& i){
67 <    i = myCutoffGroups.begin();
68 <    return i != myCutoffGroups.end()? *i : NULL;
69 <  }
70 <
71 <  //nextCutoffGroup return next cutoff group based on the iterator
72 <  CutoffGroup* nextCutoffGroup(vector<CutoffGroup*>::iterator& i){
73 <    i++;
74 <    return i != myCutoffGroups.end()? *i : NULL;
75 <  }
76 <
77 <  int getNCutoffGroups() {return nCutoffGroups;}
78 <
79 <  void setStampID( int info ) {stampID = info;}
80 <
81 <  void calcForces( void );
82 <  void atoms2rigidBodies( void );
83 <  double getPotential( void );
84 <  
85 <  void printMe( void );
86 <
87 <  void getCOM( double COM[3] );
88 <  void moveCOM( double delta[3] );
89 <  double getCOMvel( double COMvel[3] );
90 <  
91 <  double getTotalMass();
92 <
93 < private:
94 <
95 <  int stampID;   // the ID in the BASS component stamp array
96 <  int nAtoms;    // the number of atoms in the molecule
97 <  int nBonds;    // ... .. ..  . .bonds .. .. . . . .
98 <  int nBends;    // . . . . .. . .bends . . . . .. .
99 <  int nTorsions; // .. . . .. . . torsions . . .. . .
100 <  int nRigidBodies; // .. . . .. .rigid bodies . . .. . .
101 <  int nOriented; // .. . . . .. . oriented atoms . . .
102 <  int nMembers;  // .. . . . . . .atoms (legacy code) . . .
103 <  int nCutoffGroups;
104 <  
105 <  int myIndex; // mostly just for debug (and for making pressure calcs work)
106 <  int globalIndex;
107 <
108 <  Atom** myAtoms;     // the array of atoms
109 <  Bond** myBonds;     // arrays of all the short range interactions
110 <  Bend** myBends;
111 <  Torsion** myTorsions;
112 <  vector<RigidBody*>   myRigidBodies;
113 <  vector<StuntDouble*> myIntegrableObjects;
114 <  vector<CutoffGroup*> myCutoffGroups;
115 < };
116 <
117 < #endif
349 > } //namespace oopse
350 > #endif //

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines