src/parallel/ForceDecomposition.hpp

/*
 * Copyright (c) 2011 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]  Vardeman & Gezelter, in progress (2009).                        
 */
 
#ifndef PARALLEL_FORCEDECOMPOSITION_HPP
#define PARALLEL_FORCEDECOMPOSITION_HPP

#include "brains/SimInfo.hpp"
#include "nonbonded/NonBondedInteraction.hpp"

using namespace std;
namespace OpenMD {
  
  /**
   * @class ForceDecomposition 
   *
   * ForceDecomposition is an interface for passing out and collecting
   * information from many processors at various stages of the main
   * non-bonded ForceLoop.
   *
   * The pairwise force calculation has an outer-running loop (the "I"
   * loop) and an inner-running loop (the "J" loop).  In parallel
   * decompositions, these loop over different groups of atoms on
   * different processors.  Between each set of computations on the
   * local processor, data must be exchanged among the processors.
   * This can happen at different times in the calculation:
   *
   *  distributeInitialData      (parallel communication - one time only)
   *  distributeData             (parallel communication - every ForceLoop)
   *
   *  loop iLoop over nLoops     (nLoops may be 1, 2, or until self consistent)
   *  |  loop over i
   *  |  | loop over j
   *  |  | | localComputation
   *  |  |  end
   *  |  end
   *  |  if (nLoops > 1):
   *  |  |   collectIntermediateData    (parallel communication)
   *  |  |   distributeIntermediateData (parallel communication)
   *  |  endif
   *  end
   * collectData                        (parallel communication)
   *
   * ForceDecomposition provides the interface for ForceLoop to do the
   * communication steps and to iterate using the correct set of atoms
   * and cutoff groups.
   */
  class ForceDecomposition {
  public:

    ForceDecomposition(SimInfo* info) : info_(info) {}
    virtual ~ForceDecomposition() {}
    
    virtual void distributeInitialData() = 0;
    virtual void distributeData() = 0;
    virtual void collectIntermediateData() = 0;
    virtual void distributeIntermediateData() = 0;
    virtual void collectData() = 0;

    // neighbor list routines
    virtual bool checkNeighborList() = 0;
    virtual vector<pair<int, int> >  buildNeighborList() = 0;

    // group bookkeeping
    virtual pair<int, int> getGroupTypes(int cg1, int cg2) = 0;

    // Group->atom bookkeeping
    virtual vector<int> getAtomsInGroupRow(int cg1) = 0;
    virtual vector<int> getAtomsInGroupColumn(int cg2) = 0;
    virtual Vector3d getAtomToGroupVectorRow(int atom1, int cg1) = 0;
    virtual Vector3d getAtomToGroupVectorColumn(int atom2, int cg2) = 0;
    virtual RealType getMfactRow(int atom1) = 0;
    virtual RealType getMfactColumn(int atom2) = 0;

    // spatial data
    virtual Vector3d getIntergroupVector(int cg1, int cg2) = 0;
    virtual Vector3d getInteratomicVector(int atom1, int atom2) = 0;
       
    // atom bookkeeping
    virtual vector<int> getAtomList() = 0;
    virtual vector<int> getSkipsForAtom(int atom1) = 0;
    virtual bool skipAtomPair(int atom1, int atom2) = 0;
    virtual void addForceToAtomRow(int atom1, Vector3d fg) = 0;
    virtual void addForceToAtomColumn(int atom2, Vector3d fg) = 0;

    // filling interaction blocks with pointers
    virtual InteractionData fillInteractionData(int atom1, int atom2) = 0;
    virtual InteractionData fillSkipData(int atom1, int atom2) = 0;
    virtual SelfData fillSelfData(int atom1) = 0;
    
  protected:
    SimInfo* info_;   
    map<pair<int, int>, int> topoDist; //< topoDist gives the
                                       //topological distance between
                                       //two atomic sites.  This
                                       //declaration is agnostic
                                       //regarding the parallel
                                       //decomposition.  The two
                                       //indices could be local or row
                                       //& column.  It will be up to
                                       //the specific decomposition
                                       //method to fill this.
    map<pair<int, int>, bool> exclude; //< exclude is the set of pairs
                                       //to leave out of non-bonded
                                       //force evaluations.  This
                                       //declaration is agnostic
                                       //regarding the parallel
                                       //decomposition.  The two
                                       //indices could be local or row
                                       //& column.  It will be up to
                                       //the specific decomposition
                                       //method to fill this.
  };    
}
#endif
Revision:	1549
Committed:	Wed Apr 27 18:38:15 2011 UTC (14 years ago) by gezelter
File size:	6775 byte(s)
Log Message:	a few more tweaks We're getting somewhat closer to deleting fortran.
#	Content
1	/*
2	* Copyright (c) 2011 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	*/
41
42	#ifndef PARALLEL_FORCEDECOMPOSITION_HPP
43	#define PARALLEL_FORCEDECOMPOSITION_HPP
44
45	#include "brains/SimInfo.hpp"
46	#include "nonbonded/NonBondedInteraction.hpp"
47
48	using namespace std;
49	namespace OpenMD {
50
51	/**
52	* @class ForceDecomposition
53	*
54	* ForceDecomposition is an interface for passing out and collecting
55	* information from many processors at various stages of the main
56	* non-bonded ForceLoop.
57	*
58	* The pairwise force calculation has an outer-running loop (the "I"
59	* loop) and an inner-running loop (the "J" loop). In parallel
60	* decompositions, these loop over different groups of atoms on
61	* different processors. Between each set of computations on the
62	* local processor, data must be exchanged among the processors.
63	* This can happen at different times in the calculation:
64	*
65	* distributeInitialData (parallel communication - one time only)
66	* distributeData (parallel communication - every ForceLoop)
67	*
68	* loop iLoop over nLoops (nLoops may be 1, 2, or until self consistent)
69	* \| loop over i
70	* \| \| loop over j
71	* \| \| \| localComputation
72	* \| \| end
73	* \| end
74	* \| if (nLoops > 1):
75	* \| \| collectIntermediateData (parallel communication)
76	* \| \| distributeIntermediateData (parallel communication)
77	* \| endif
78	* end
79	* collectData (parallel communication)
80	*
81	* ForceDecomposition provides the interface for ForceLoop to do the
82	* communication steps and to iterate using the correct set of atoms
83	* and cutoff groups.
84	*/
85	class ForceDecomposition {
86	public:
87
88	ForceDecomposition(SimInfo* info) : info_(info) {}
89	virtual ~ForceDecomposition() {}
90
91	virtual void distributeInitialData() = 0;
92	virtual void distributeData() = 0;
93	virtual void collectIntermediateData() = 0;
94	virtual void distributeIntermediateData() = 0;
95	virtual void collectData() = 0;
96
97	// neighbor list routines
98	virtual bool checkNeighborList() = 0;
99	virtual vector<pair<int, int> > buildNeighborList() = 0;
100
101	// group bookkeeping
102	virtual pair<int, int> getGroupTypes(int cg1, int cg2) = 0;
103
104	// Group->atom bookkeeping
105	virtual vector<int> getAtomsInGroupRow(int cg1) = 0;
106	virtual vector<int> getAtomsInGroupColumn(int cg2) = 0;
107	virtual Vector3d getAtomToGroupVectorRow(int atom1, int cg1) = 0;
108	virtual Vector3d getAtomToGroupVectorColumn(int atom2, int cg2) = 0;
109	virtual RealType getMfactRow(int atom1) = 0;
110	virtual RealType getMfactColumn(int atom2) = 0;
111
112	// spatial data
113	virtual Vector3d getIntergroupVector(int cg1, int cg2) = 0;
114	virtual Vector3d getInteratomicVector(int atom1, int atom2) = 0;
115
116	// atom bookkeeping
117	virtual vector<int> getAtomList() = 0;
118	virtual vector<int> getSkipsForAtom(int atom1) = 0;
119	virtual bool skipAtomPair(int atom1, int atom2) = 0;
120	virtual void addForceToAtomRow(int atom1, Vector3d fg) = 0;
121	virtual void addForceToAtomColumn(int atom2, Vector3d fg) = 0;
122
123	// filling interaction blocks with pointers
124	virtual InteractionData fillInteractionData(int atom1, int atom2) = 0;
125	virtual InteractionData fillSkipData(int atom1, int atom2) = 0;
126	virtual SelfData fillSelfData(int atom1) = 0;
127
128	protected:
129	SimInfo* info_;
130	map<pair<int, int>, int> topoDist; //< topoDist gives the
131	//topological distance between
132	//two atomic sites. This
133	//declaration is agnostic
134	//regarding the parallel
135	//decomposition. The two
136	//indices could be local or row
137	//& column. It will be up to
138	//the specific decomposition
139	//method to fill this.
140	map<pair<int, int>, bool> exclude; //< exclude is the set of pairs
141	//to leave out of non-bonded
142	//force evaluations. This
143	//declaration is agnostic
144	//regarding the parallel
145	//decomposition. The two
146	//indices could be local or row
147	//& column. It will be up to
148	//the specific decomposition
149	//method to fill this.
150	};
151	}
152	#endif