| 1 | 
  | 
/* | 
| 2 | 
< | 
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. | 
| 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 | 
| 39 | 
  | 
 * [4]  Vardeman & Gezelter, in progress (2009).                         | 
| 40 | 
  | 
 */ | 
| 41 | 
  | 
  | 
| 42 | 
< | 
#ifndef PARALLEL_DECOMPOSITION_HPP | 
| 43 | 
< | 
#define PARALLEL_DECOMPOSITION_HPP | 
| 42 | 
> | 
#ifndef PARALLEL_FORCEDECOMPOSITION_HPP | 
| 43 | 
> | 
#define PARALLEL_FORCEDECOMPOSITION_HPP | 
| 44 | 
  | 
 | 
| 45 | 
+ | 
#include "brains/SimInfo.hpp" | 
| 46 | 
  | 
#include "brains/SnapshotManager.hpp" | 
| 47 | 
< | 
#include "types/AtomType.hpp" | 
| 47 | 
> | 
#include "nonbonded/NonBondedInteraction.hpp" | 
| 48 | 
  | 
 | 
| 49 | 
  | 
using namespace std; | 
| 50 | 
  | 
namespace OpenMD { | 
| 51 | 
  | 
   | 
| 52 | 
  | 
  /** | 
| 53 | 
< | 
   * @class Decomposition  | 
| 53 | 
< | 
   * Decomposition is an interface for passing out and collecting information | 
| 54 | 
< | 
   * from many processors at various stages of the main non-bonded ForceLoop. | 
| 53 | 
> | 
   * @class ForceDecomposition  | 
| 54 | 
  | 
   * | 
| 55 | 
+ | 
   * ForceDecomposition is an interface for passing out and collecting | 
| 56 | 
+ | 
   * information from many processors at various stages of the main | 
| 57 | 
+ | 
   * non-bonded ForceLoop. | 
| 58 | 
+ | 
   * | 
| 59 | 
  | 
   * The pairwise force calculation has an outer-running loop (the "I" | 
| 60 | 
  | 
   * loop) and an inner-running loop (the "J" loop).  In parallel | 
| 61 | 
  | 
   * decompositions, these loop over different groups of atoms on | 
| 65 | 
  | 
   * | 
| 66 | 
  | 
   *  distributeInitialData      (parallel communication - one time only) | 
| 67 | 
  | 
   *  distributeData             (parallel communication - every ForceLoop) | 
| 68 | 
< | 
   *  loop over i | 
| 69 | 
< | 
   *  | loop over j | 
| 70 | 
< | 
   *  | | localComputation | 
| 68 | 
> | 
   * | 
| 69 | 
> | 
   *  loop iLoop over nLoops     (nLoops may be 1, 2, or until self consistent) | 
| 70 | 
> | 
   *  |  loop over i | 
| 71 | 
> | 
   *  |  | loop over j | 
| 72 | 
> | 
   *  |  | | localComputation | 
| 73 | 
> | 
   *  |  |  end | 
| 74 | 
  | 
   *  |  end | 
| 75 | 
+ | 
   *  |  if (nLoops > 1): | 
| 76 | 
+ | 
   *  |  |   collectIntermediateData    (parallel communication) | 
| 77 | 
+ | 
   *  |  |   distributeIntermediateData (parallel communication) | 
| 78 | 
+ | 
   *  |  endif | 
| 79 | 
  | 
   *  end | 
| 80 | 
< | 
   *  collectIntermediateData    (parallel communication) | 
| 71 | 
< | 
   *  distributeIntermediateData (parallel communication) | 
| 72 | 
< | 
   *  loop over i | 
| 73 | 
< | 
   *  | loop over j | 
| 74 | 
< | 
   *  | | localComputation | 
| 75 | 
< | 
   *  |  end | 
| 76 | 
< | 
   *  end | 
| 77 | 
< | 
   * collectData                  (parallel communication) | 
| 80 | 
> | 
   * collectData                        (parallel communication) | 
| 81 | 
  | 
   * | 
| 82 | 
< | 
   * Decomposition provides the interface for ForceLoop to do the | 
| 82 | 
> | 
   * ForceDecomposition provides the interface for ForceLoop to do the | 
| 83 | 
  | 
   * communication steps and to iterate using the correct set of atoms | 
| 84 | 
  | 
   * and cutoff groups. | 
| 85 | 
  | 
   */ | 
| 86 | 
< | 
  class Decomposition { | 
| 86 | 
> | 
  class ForceDecomposition { | 
| 87 | 
  | 
  public: | 
| 88 | 
  | 
 | 
| 89 | 
< | 
    Decomposition(SnapshotManager* sman) : sman_(sman) {} | 
| 90 | 
< | 
    virtual ~Decomposition() {} | 
| 89 | 
> | 
    ForceDecomposition(SimInfo* info); | 
| 90 | 
> | 
    virtual ~ForceDecomposition() {} | 
| 91 | 
  | 
     | 
| 92 | 
  | 
    virtual void distributeInitialData() = 0; | 
| 93 | 
  | 
    virtual void distributeData() = 0; | 
| 95 | 
  | 
    virtual void distributeIntermediateData() = 0; | 
| 96 | 
  | 
    virtual void collectData() = 0; | 
| 97 | 
  | 
 | 
| 98 | 
< | 
    virtual unsigned int getNcutoffGroupsI() = 0; | 
| 99 | 
< | 
    virtual unsigned int getNcutoffGroupsJ() = 0; | 
| 98 | 
> | 
    // neighbor list routines | 
| 99 | 
> | 
    virtual bool checkNeighborList(); | 
| 100 | 
> | 
    virtual vector<pair<int, int> >  buildNeighborList() = 0; | 
| 101 | 
  | 
 | 
| 102 | 
< | 
    virtual vector<int> getAtomsInGroupI(int whichCGI) = 0; | 
| 103 | 
< | 
    virtual vector<int> getAtomsInGroupJ(int whichCGJ) = 0; | 
| 102 | 
> | 
    // group bookkeeping | 
| 103 | 
> | 
    virtual pair<int, int> getGroupTypes(int cg1, int cg2) = 0; | 
| 104 | 
  | 
 | 
| 105 | 
< | 
    virtual AtomType* getAtomTypeI(int whichAtomI) = 0; | 
| 106 | 
< | 
    virtual AtomType* getAtomTypeJ(int whichAtomJ) = 0; | 
| 105 | 
> | 
    // Group->atom bookkeeping | 
| 106 | 
> | 
    virtual vector<int> getAtomsInGroupRow(int cg1) = 0;  | 
| 107 | 
> | 
    virtual vector<int> getAtomsInGroupColumn(int cg2) = 0; | 
| 108 | 
> | 
 | 
| 109 | 
> | 
    virtual Vector3d getAtomToGroupVectorRow(int atom1, int cg1) = 0; | 
| 110 | 
> | 
    virtual Vector3d getAtomToGroupVectorColumn(int atom2, int cg2) = 0; | 
| 111 | 
> | 
    virtual RealType getMassFactorRow(int atom1) = 0; | 
| 112 | 
> | 
    virtual RealType getMassFactorColumn(int atom2) = 0; | 
| 113 | 
> | 
 | 
| 114 | 
> | 
    // spatial data | 
| 115 | 
> | 
    virtual Vector3d getIntergroupVector(int cg1, int cg2) = 0; | 
| 116 | 
> | 
    virtual Vector3d getInteratomicVector(int atom1, int atom2) = 0; | 
| 117 | 
> | 
        | 
| 118 | 
> | 
    // atom bookkeeping | 
| 119 | 
> | 
    virtual int getNAtomsInRow() = 0; | 
| 120 | 
> | 
    virtual vector<int> getSkipsForRowAtom(int atom1) = 0; | 
| 121 | 
> | 
    virtual bool skipAtomPair(int atom1, int atom2) = 0; | 
| 122 | 
> | 
    virtual void addForceToAtomRow(int atom1, Vector3d fg) = 0; | 
| 123 | 
> | 
    virtual void addForceToAtomColumn(int atom2, Vector3d fg) = 0; | 
| 124 | 
> | 
 | 
| 125 | 
> | 
    // filling interaction blocks with pointers | 
| 126 | 
> | 
    virtual InteractionData fillInteractionData(int atom1, int atom2) = 0; | 
| 127 | 
> | 
    virtual InteractionData fillSkipData(int atom1, int atom2) = 0; | 
| 128 | 
> | 
    virtual SelfData fillSelfData(int atom1); | 
| 129 | 
  | 
     | 
| 130 | 
  | 
  protected: | 
| 131 | 
< | 
    SnapshotManager* sman_; | 
| 131 | 
> | 
    SimInfo* info_;    | 
| 132 | 
> | 
    SnapshotManager* sman_;     | 
| 133 | 
> | 
    Snapshot* snap_; | 
| 134 | 
> | 
    int storageLayout_; | 
| 135 | 
> | 
    RealType skinThickness_;   /**< Verlet neighbor list skin thickness */     | 
| 136 | 
> | 
 | 
| 137 | 
> | 
    map<pair<int, int>, int> topoDist; //< topoDist gives the | 
| 138 | 
> | 
                                       //topological distance between | 
| 139 | 
> | 
                                       //two atomic sites.  This | 
| 140 | 
> | 
                                       //declaration is agnostic | 
| 141 | 
> | 
                                       //regarding the parallel | 
| 142 | 
> | 
                                       //decomposition.  The two | 
| 143 | 
> | 
                                       //indices could be local or row | 
| 144 | 
> | 
                                       //& column.  It will be up to | 
| 145 | 
> | 
                                       //the specific decomposition | 
| 146 | 
> | 
                                       //method to fill this. | 
| 147 | 
> | 
    map<pair<int, int>, bool> exclude; //< exclude is the set of pairs | 
| 148 | 
> | 
                                       //to leave out of non-bonded | 
| 149 | 
> | 
                                       //force evaluations.  This | 
| 150 | 
> | 
                                       //declaration is agnostic | 
| 151 | 
> | 
                                       //regarding the parallel | 
| 152 | 
> | 
                                       //decomposition.  The two | 
| 153 | 
> | 
                                       //indices could be local or row | 
| 154 | 
> | 
                                       //& column.  It will be up to | 
| 155 | 
> | 
                                       //the specific decomposition | 
| 156 | 
> | 
                                       //method to fill this. | 
| 157 | 
> | 
 | 
| 158 | 
> | 
    vector<vector<int> > groupList_; | 
| 159 | 
> | 
    vector<Vector3i> cellOffsets_; | 
| 160 | 
> | 
    Vector3i nCells_; | 
| 161 | 
> | 
    vector<vector<int> > cellList_; | 
| 162 | 
> | 
    vector<Vector3d> saved_CG_positions_; | 
| 163 | 
> | 
 | 
| 164 | 
  | 
  };     | 
| 165 | 
  | 
} | 
| 166 | 
  | 
#endif |