src/primitives/CutoffGroup.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).
 */
 
#ifndef PRIMITIVES_CUTOFFGROUP_HPP

#define PRIMITIVES_CUTOFFGROUP_HPP

#include "primitives/Atom.hpp"
#include "math/Vector3.hpp"

namespace OpenMD {
  class CutoffGroup {
  public:
    
    CutoffGroup() :  snapshotMan_(NULL) {

      storage_ = &Snapshot::cgData;
      haveTotalMass = false;
      totalMass = 0.0;
    }
    
    /**
     * Sets the Snapshot Manager of this cutoffGroup
     */
    void setSnapshotManager(SnapshotManager* sman) {
      snapshotMan_ = sman;
    }


    void addAtom(Atom *atom) {
      cutoffAtomList.push_back(atom);
    }
    
    Atom *beginAtom(std::vector<Atom *>::iterator & i) {
      i = cutoffAtomList.begin();
      return i != cutoffAtomList.end() ? *i : NULL;
    }
    
    Atom *nextAtom(std::vector<Atom *>::iterator & i) {
      i++;
      return i != cutoffAtomList.end() ? *i : NULL;
    }

    std::vector<Atom*> getAtoms() { return cutoffAtomList; }
    RealType getMass() {
      std::vector<Atom *>::iterator i;
      Atom * atom;
      RealType mass;
      
      if (!haveTotalMass) {
        totalMass = 0;
        
        for(atom = beginAtom(i); atom != NULL; atom = nextAtom(i)) {
          mass = atom->getMass();
          totalMass += mass;
        }
        
        haveTotalMass = true;
      }
      
      return totalMass;
    }
    
    void updateCOM() {
      std::vector<Atom *>::iterator i;
      Atom * atom;

      DataStorage&  data = snapshotMan_->getCurrentSnapshot()->*storage_;
     
      totalMass = getMass();
      
      if (cutoffAtomList.size() == 1) {
        data.position[localIndex_] = beginAtom(i)->getPos();
      } else {
        data.position[localIndex_] = V3Zero;
        for(atom = beginAtom(i); atom != NULL; atom = nextAtom(i)) {
          data.position[localIndex_] += atom->getMass() * atom->getPos();
        }        
        data.position[localIndex_] /= totalMass;
      }
    }


    Vector3d getPos() {
      return ((snapshotMan_->getCurrentSnapshot())->*storage_).position[localIndex_];      
    }
    
    int getNumAtom() {
      return cutoffAtomList.size();
    }
    
    int getGlobalIndex() {
      return globalIndex;
    }
    
    void setGlobalIndex(int id) {
      this->globalIndex = id;
    }

    /** 
     * Returns the local index of this cutoffGroup
     * @return the local index of this cutoffGroup
     */
    int getLocalIndex() {
      return localIndex_;
    }

    /**
     * Sets the local index of this cutoffGroup
     * @param index new index to be set
     */        
    void setLocalIndex(int index) {
      localIndex_ = index;
    }
    
  private:
    
    std::vector<Atom *>cutoffAtomList;
    bool haveTotalMass;
    RealType totalMass;
    int globalIndex;    

    int localIndex_;
    DataStoragePointer storage_;
    SnapshotManager* snapshotMan_;

  };  
} //end namespace OpenMD
#endif //PRIMITIVES_CUTOFFGROUP_HPP  
Revision:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	5000 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			#ifndef PRIMITIVES_CUTOFFGROUP_HPP
44
45			#define PRIMITIVES_CUTOFFGROUP_HPP
46
47	tim	3	#include "primitives/Atom.hpp"
48	gezelter	246	#include "math/Vector3.hpp"
49	gezelter	2
50	gezelter	1390	namespace OpenMD {
51	gezelter	507	class CutoffGroup {
52			public:
53	gezelter	1211
54	gezelter	1540	CutoffGroup() : snapshotMan_(NULL) {
55
56			storage_ = &Snapshot::cgData;
57	gezelter	507	haveTotalMass = false;
58			totalMass = 0.0;
59			}
60	gezelter	1211
61	gezelter	1540	/**
62			* Sets the Snapshot Manager of this cutoffGroup
63			*/
64			void setSnapshotManager(SnapshotManager* sman) {
65			snapshotMan_ = sman;
66			}
67
68
69	gezelter	507	void addAtom(Atom *atom) {
70			cutoffAtomList.push_back(atom);
71			}
72	gezelter	1211
73	gezelter	507	Atom beginAtom(std::vector<Atom >::iterator & i) {
74			i = cutoffAtomList.begin();
75			return i != cutoffAtomList.end() ? *i : NULL;
76			}
77	gezelter	1211
78	gezelter	507	Atom nextAtom(std::vector<Atom >::iterator & i) {
79			i++;
80			return i != cutoffAtomList.end() ? *i : NULL;
81			}
82	gezelter	2
83	gezelter	507	std::vector<Atom*> getAtoms() { return cutoffAtomList; }
84	tim	963	RealType getMass() {
85	gezelter	507	std::vector<Atom *>::iterator i;
86			Atom * atom;
87	tim	963	RealType mass;
88	gezelter	1211
89	gezelter	507	if (!haveTotalMass) {
90			totalMass = 0;
91	gezelter	1211
92	gezelter	507	for(atom = beginAtom(i); atom != NULL; atom = nextAtom(i)) {
93			mass = atom->getMass();
94			totalMass += mass;
95			}
96	gezelter	1211
97	gezelter	507	haveTotalMass = true;
98			}
99	gezelter	1211
100	gezelter	507	return totalMass;
101			}
102	gezelter	1211
103	gezelter	1540	void updateCOM() {
104	gezelter	507	std::vector<Atom *>::iterator i;
105			Atom * atom;
106	gezelter	1540
107			DataStorage& data = snapshotMan_->getCurrentSnapshot()->*storage_;
108
109	gezelter	507	totalMass = getMass();
110	gezelter	1211
111	gezelter	507	if (cutoffAtomList.size() == 1) {
112	gezelter	1540	data.position[localIndex_] = beginAtom(i)->getPos();
113	gezelter	507	} else {
114	gezelter	1540	data.position[localIndex_] = V3Zero;
115	gezelter	507	for(atom = beginAtom(i); atom != NULL; atom = nextAtom(i)) {
116	gezelter	1540	data.position[localIndex_] += atom->getMass() * atom->getPos();
117			}
118			data.position[localIndex_] /= totalMass;
119	gezelter	507	}
120			}
121	gezelter	1540
122
123	gezelter	1551	Vector3d getPos() {
124	gezelter	1540	return ((snapshotMan_->getCurrentSnapshot())->*storage_).position[localIndex_];
125			}
126	gezelter	1211
127	gezelter	507	int getNumAtom() {
128			return cutoffAtomList.size();
129			}
130	gezelter	1211
131	gezelter	507	int getGlobalIndex() {
132			return globalIndex;
133			}
134	gezelter	1211
135	gezelter	507	void setGlobalIndex(int id) {
136			this->globalIndex = id;
137			}
138	gezelter	1540
139			/**
140			* Returns the local index of this cutoffGroup
141			* @return the local index of this cutoffGroup
142			*/
143			int getLocalIndex() {
144			return localIndex_;
145			}
146
147			/**
148			* Sets the local index of this cutoffGroup
149			* @param index new index to be set
150			*/
151			void setLocalIndex(int index) {
152			localIndex_ = index;
153			}
154	gezelter	1211
155	gezelter	507	private:
156	gezelter	1211
157	gezelter	507	std::vector<Atom *>cutoffAtomList;
158			bool haveTotalMass;
159	tim	963	RealType totalMass;
160	gezelter	1540	int globalIndex;
161
162			int localIndex_;
163			DataStoragePointer storage_;
164			SnapshotManager* snapshotMan_;
165
166	gezelter	1211	};
167	gezelter	1390	} //end namespace OpenMD
168	gezelter	246	#endif //PRIMITIVES_CUTOFFGROUP_HPP