src/primitives/Molecule.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 Molecule.hpp
 * @author    tlin
 * @date  10/25/2004
 * @version 1.0
 */ 

#ifndef PRIMITIVES_MOLECULE_HPP
#define PRIMITIVES_MOLECULE_HPP
#include <vector>
#include <iostream>

#include "constraints/ConstraintPair.hpp"
#include "math/Vector3.hpp"
#include "primitives/Atom.hpp"
#include "primitives/RigidBody.hpp"
#include "primitives/Bond.hpp"
#include "primitives/Bend.hpp"
#include "primitives/Torsion.hpp"
#include "primitives/Inversion.hpp"
#include "primitives/CutoffGroup.hpp"
#include "utils/PropertyMap.hpp"

namespace OpenMD{

  class Constraint;

  /**
   * @class Molecule Molecule.hpp "primitives/Molecule.hpp"
   * @brief
   */
  class Molecule {
  public:

    typedef std::vector<Atom*>::iterator AtomIterator;
    typedef std::vector<Bond*>::iterator BondIterator;
    typedef std::vector<Bend*>::iterator BendIterator;
    typedef std::vector<Torsion*>::iterator TorsionIterator;
    typedef std::vector<Inversion*>::iterator InversionIterator;
    typedef std::vector<RigidBody*>::iterator RigidBodyIterator;
    typedef std::vector<CutoffGroup*>::iterator CutoffGroupIterator;
    typedef std::vector<StuntDouble*>::iterator IntegrableObjectIterator;
    typedef std::vector<ConstraintPair*>::iterator ConstraintPairIterator;
    typedef std::vector<ConstraintElem*>::iterator ConstraintElemIterator;
    
    
    Molecule(int stampId, int globalIndex, const std::string& molName);
    virtual ~Molecule();

    /**
     * Returns the global index of this molecule.
     * @return  the global index of this molecule 
     */
    int getGlobalIndex() {
      return globalIndex_;
    }
    
    /**
     * Returns the stamp id of this molecule
     * @note Ideally, every molecule should keep a pointer of its
     * molecule stamp instead of its stamp id. However, the pointer
     * will become invalid, if the molecule migrate to other
     * processor.
     */
    int getStampId() {
      return stampId_;
    }
    
    /** Returns the name of the molecule */
    std::string getType() {
      return moleculeName_;
    }
    
    /**
     * Sets the global index of this molecule.
     * @param new global index to be set
     */
    void setGlobalIndex(int index) {
      globalIndex_ = index;
    }
    
    
    /** add an atom into this molecule */
    void addAtom(Atom* atom);
    
    /** add a bond into this molecule */
    void addBond(Bond* bond);
    
    /** add a bend into this molecule */
    void addBend(Bend* bend);
    
    /** add a torsion into this molecule*/
    void addTorsion(Torsion* torsion);

    /** add an improper torsion into this molecule*/
    void addInversion(Inversion* inversion);
    
    /** add a rigidbody into this molecule */
    void addRigidBody(RigidBody *rb);
    
    /** add a cutoff group into this molecule */
    void addCutoffGroup(CutoffGroup* cp);     
    
    void addConstraintPair(ConstraintPair* consPair);
    
    void addConstraintElem(ConstraintElem* consElem);
    
    /** */
    void complete();
    
    /** Returns the total number of atoms in this molecule */
    unsigned int getNAtoms() {
      return atoms_.size();
    }
    
    /** Returns the total number of bonds in this molecule */        
    unsigned int getNBonds(){
      return bonds_.size();
    }
    
    /** Returns the total number of bends in this molecule */        
    unsigned int getNBends() {
      return bends_.size();
    }
    
    /** Returns the total number of torsions in this molecule */        
    unsigned int getNTorsions() {
      return torsions_.size();
    }

    /** Returns the total number of improper torsions in this molecule */
    unsigned int getNInversions() {
      return inversions_.size();
    }
    
    /** Returns the total number of rigid bodies in this molecule */        
    unsigned int getNRigidBodies() {
      return rigidBodies_.size();
    }
    
    /** Returns the total number of integrable objects in this molecule */
    unsigned int getNIntegrableObjects() {
      return integrableObjects_.size();
    }
    
    /** Returns the total number of cutoff groups in this molecule */
    unsigned int getNCutoffGroups() {
      return cutoffGroups_.size();
    }
    
    /** Returns the total number of constraints in this molecule */
    unsigned int getNConstraintPairs() {
      return constraintPairs_.size();
    }
    
    Atom* getAtomAt(unsigned int i) {
      assert(i < atoms_.size());
      return atoms_[i];
    }
    
    RigidBody* getRigidBodyAt(unsigned int i) {
      assert(i < rigidBodies_.size());
      return rigidBodies_[i];
    }
    
    Atom* beginAtom(std::vector<Atom*>::iterator& i) {
      i = atoms_.begin();
      return (i == atoms_.end()) ? NULL : *i;
    }
    
    Atom* nextAtom(std::vector<Atom*>::iterator& i) {
      ++i;
      return (i == atoms_.end()) ? NULL : *i;    
    }
    
    Bond* beginBond(std::vector<Bond*>::iterator& i) {
      i = bonds_.begin();
      return (i == bonds_.end()) ? NULL : *i;
    }
    
    Bond* nextBond(std::vector<Bond*>::iterator& i) {
      ++i;
      return (i == bonds_.end()) ? NULL : *i;    
      
    }
    
    Bend* beginBend(std::vector<Bend*>::iterator& i) {
      i = bends_.begin();
      return (i == bends_.end()) ? NULL : *i;
    }
    
    Bend* nextBend(std::vector<Bend*>::iterator& i) {
      ++i;
      return (i == bends_.end()) ? NULL : *i;    
    }
    
    Torsion* beginTorsion(std::vector<Torsion*>::iterator& i) {
      i = torsions_.begin();
      return (i == torsions_.end()) ? NULL : *i;
    }
    
    Torsion* nextTorsion(std::vector<Torsion*>::iterator& i) {
      ++i;
      return (i == torsions_.end()) ? NULL : *i;    
    }    

    Inversion* beginInversion(std::vector<Inversion*>::iterator& i) {
      i = inversions_.begin();
      return (i == inversions_.end()) ? NULL : *i;
    }
    
    Inversion* nextInversion(std::vector<Inversion*>::iterator& i) {
      ++i;
      return (i == inversions_.end()) ? NULL : *i;    
    }    
    
    RigidBody* beginRigidBody(std::vector<RigidBody*>::iterator& i) {
      i = rigidBodies_.begin();
      return (i == rigidBodies_.end()) ? NULL : *i;
    }
    
    RigidBody* nextRigidBody(std::vector<RigidBody*>::iterator& i) {
      ++i;
      return (i == rigidBodies_.end()) ? NULL : *i;    
    }
    
    StuntDouble* beginIntegrableObject(std::vector<StuntDouble*>::iterator& i) {
      i = integrableObjects_.begin();
      return (i == integrableObjects_.end()) ? NULL : *i;
    }
    
    StuntDouble* nextIntegrableObject(std::vector<StuntDouble*>::iterator& i) {
      ++i;
      return (i == integrableObjects_.end()) ? NULL : *i;    
    }    
    
    CutoffGroup* beginCutoffGroup(std::vector<CutoffGroup*>::iterator& i) {
      i = cutoffGroups_.begin();
      return (i == cutoffGroups_.end()) ? NULL : *i;
    }

    CutoffGroup* nextCutoffGroup(std::vector<CutoffGroup*>::iterator& i) {
      ++i;
      return (i == cutoffGroups_.end()) ? NULL : *i;    
    } 
    
    ConstraintPair* beginConstraintPair(std::vector<ConstraintPair*>::iterator& i) {
      i = constraintPairs_.begin();
      return (i == constraintPairs_.end()) ? NULL : *i;
    }
    
    ConstraintPair* nextConstraintPair(std::vector<ConstraintPair*>::iterator& i) {            
      ++i;
      return (i == constraintPairs_.end()) ? NULL : *i;    
    }         
    
    ConstraintElem* beginConstraintElem(std::vector<ConstraintElem*>::iterator& i) {
      i = constraintElems_.begin();
      return (i == constraintElems_.end()) ? NULL : *i;
    }
    
    ConstraintElem* nextConstraintElem(std::vector<ConstraintElem*>::iterator& i) {            
      ++i;
      return (i == constraintElems_.end()) ? NULL : *i;    
    }
        
    /** 
     * Returns the total potential energy of short range interaction
     * of this molecule 
     */    
    RealType getPotential();
    
    /** get total mass of this molecule */        
    RealType getMass();
    
    /** return the center of mass of this molecule */
    Vector3d getCom();
    
    /** Moves the center of this molecule */
    void moveCom(const Vector3d& delta);
    
    /** Returns the velocity of center of mass of this molecule */
    Vector3d getComVel();

    std::string getMoleculeName() { 
      return moleculeName_;
    }
        
    friend std::ostream& operator <<(std::ostream& o, Molecule& mol);

    //below functions are just forward functions
    /**
     * Adds property into property map
     * @param genData GenericData to be added into PropertyMap
     */
    void addProperty(GenericData* genData);

    /**
     * Removes property from PropertyMap by name
     * @param propName the name of property to be removed
     */
    void removeProperty(const std::string& propName);

    /**
     * clear all of the properties
     */
    void clearProperties();

    /**
     * Returns all names of properties
     * @return all names of properties
     */
    std::vector<std::string> getPropertyNames();

    /**
     * Returns all of the properties in PropertyMap
     * @return all of the properties in PropertyMap
     */      
    std::vector<GenericData*> getProperties();

    /**
     * Returns property 
     * @param propName name of property
     * @return a pointer point to property with propName. If no property named propName
     * exists, return NULL
     */      
    GenericData* getPropertyByName(const std::string& propName);
    
  private:
    
    int globalIndex_;
    
    std::vector<Atom*> atoms_;
    std::vector<Bond*> bonds_;
    std::vector<Bend*> bends_;
    std::vector<Torsion*> torsions_;
    std::vector<Inversion*> inversions_;
    std::vector<RigidBody*> rigidBodies_;
    std::vector<StuntDouble*> integrableObjects_;
    std::vector<CutoffGroup*> cutoffGroups_;
    std::vector<ConstraintPair*> constraintPairs_;
    std::vector<ConstraintElem*> constraintElems_;
    int stampId_;
    std::string moleculeName_;
    PropertyMap properties_;

  };

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