| 1 | 
< | 
 /* | 
| 1 | 
> | 
/* | 
| 2 | 
  | 
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. | 
| 3 | 
  | 
 * | 
| 4 | 
  | 
 * The University of Notre Dame grants you ("Licensee") a | 
| 39 | 
  | 
 * such damages. | 
| 40 | 
  | 
 */ | 
| 41 | 
  | 
  | 
| 42 | 
< | 
 /** | 
| 43 | 
< | 
  * @file SimCreatorr.hpp | 
| 44 | 
< | 
  * @author tlin | 
| 45 | 
< | 
  * @date 11/02/2004 | 
| 46 | 
< | 
  * @time 12:126am | 
| 47 | 
< | 
  * @version 1.0 | 
| 48 | 
< | 
  */ | 
| 42 | 
> | 
/** | 
| 43 | 
> | 
 * @file SimCreatorr.hpp | 
| 44 | 
> | 
 * @author tlin | 
| 45 | 
> | 
 * @date 11/02/2004 | 
| 46 | 
> | 
 * @time 12:126am | 
| 47 | 
> | 
 * @version 1.0 | 
| 48 | 
> | 
 */ | 
| 49 | 
  | 
 | 
| 50 | 
  | 
#ifndef BRAINS_SIMCREATOR_HPP | 
| 51 | 
  | 
#define BRAINS_SIMCREATOR_HPP | 
| 53 | 
  | 
 | 
| 54 | 
  | 
#include "primitives/Molecule.hpp" | 
| 55 | 
  | 
#include "brains/SimInfo.hpp" | 
| 56 | 
– | 
#include "types/MakeStamps.hpp" | 
| 56 | 
  | 
#include "io/Globals.hpp" | 
| 57 | 
  | 
#include "UseTheForce/ForceField.hpp" | 
| 58 | 
  | 
 | 
| 60 | 
– | 
// this routine is defined in BASS_interface.cpp | 
| 61 | 
– | 
//another OOPS | 
| 62 | 
– | 
extern void set_interface_stamps( MakeStamps* ms, Globals* g ); | 
| 63 | 
– | 
 | 
| 59 | 
  | 
namespace oopse { | 
| 60 | 
  | 
 | 
| 61 | 
< | 
/** | 
| 62 | 
< | 
 * @class SimCreator SimCreator.hpp "brains/SimCreator.hpp" | 
| 63 | 
< | 
 * The only responsibility of SimCreator is to parse the meta-data file and create a SimInfo | 
| 64 | 
< | 
 * instance based on the information returned by parser.  | 
| 65 | 
< | 
 */ | 
| 66 | 
< | 
class SimCreator { | 
| 67 | 
< | 
    public: | 
| 61 | 
> | 
  /** | 
| 62 | 
> | 
   * @class SimCreator SimCreator.hpp "brains/SimCreator.hpp" | 
| 63 | 
> | 
   * The only responsibility of SimCreator is to parse the meta-data file and create a SimInfo | 
| 64 | 
> | 
   * instance based on the information returned by parser.  | 
| 65 | 
> | 
   */ | 
| 66 | 
> | 
  class SimCreator { | 
| 67 | 
> | 
  public: | 
| 68 | 
  | 
 | 
| 69 | 
< | 
        virtual ~SimCreator() {} | 
| 69 | 
> | 
    virtual ~SimCreator() {} | 
| 70 | 
  | 
 | 
| 71 | 
< | 
        /** | 
| 72 | 
< | 
         * Setup Simulation | 
| 73 | 
< | 
         * @return a pointer to SimInfo | 
| 74 | 
< | 
         * @param mdfile the meta-data file name | 
| 75 | 
< | 
         */ | 
| 76 | 
< | 
        SimInfo* createSim(const std::string & mdFileName, bool loadInitCoords = true); | 
| 71 | 
> | 
    /** | 
| 72 | 
> | 
     * Setup Simulation | 
| 73 | 
> | 
     * @return a pointer to SimInfo | 
| 74 | 
> | 
     * @param mdfile the meta-data file name | 
| 75 | 
> | 
     */ | 
| 76 | 
> | 
    SimInfo* createSim(const std::string & mdFileName, bool loadInitCoords = true); | 
| 77 | 
  | 
         | 
| 78 | 
< | 
    private: | 
| 78 | 
> | 
  private: | 
| 79 | 
  | 
         | 
| 80 | 
< | 
        /** | 
| 81 | 
< | 
         * Parses the meta-data file | 
| 82 | 
< | 
         * @param mdfile | 
| 83 | 
< | 
         * @param stamps | 
| 84 | 
< | 
         * @param simParams | 
| 85 | 
< | 
         */ | 
| 91 | 
< | 
        void parseFile(const std::string mdFileName,  MakeStamps* stamps, Globals* simParams); | 
| 80 | 
> | 
    /** | 
| 81 | 
> | 
     * Parses the meta-data file | 
| 82 | 
> | 
     * @param mdfile | 
| 83 | 
> | 
     * @return simParams | 
| 84 | 
> | 
     */ | 
| 85 | 
> | 
    Globals*  parseFile(const std::string mdFileName); | 
| 86 | 
  | 
 | 
| 87 | 
  | 
 | 
| 88 | 
< | 
        /** create the molecules belong to current processor*/ | 
| 89 | 
< | 
        virtual void createMolecules(SimInfo* info); | 
| 88 | 
> | 
    /** create the molecules belong to current processor*/ | 
| 89 | 
> | 
    virtual void createMolecules(SimInfo* info); | 
| 90 | 
  | 
 | 
| 91 | 
< | 
        /**  | 
| 92 | 
< | 
         * Sets the global index for atoms, rigidbodies and cutoff groups and fill up | 
| 93 | 
< | 
         * globalGroupMembership and globalMolMembership arrays which map atoms' | 
| 94 | 
< | 
         * global index to the global index of the groups (or molecules) they belong to. | 
| 95 | 
< | 
         * These array are never changed during the simulation. | 
| 96 | 
< | 
         */ | 
| 97 | 
< | 
        void setGlobalIndex(SimInfo* info); | 
| 91 | 
> | 
    /**  | 
| 92 | 
> | 
     * Sets the global index for atoms, rigidbodies and cutoff groups and fill up | 
| 93 | 
> | 
     * globalGroupMembership and globalMolMembership arrays which map atoms' | 
| 94 | 
> | 
     * global index to the global index of the groups (or molecules) they belong to. | 
| 95 | 
> | 
     * These array are never changed during the simulation. | 
| 96 | 
> | 
     */ | 
| 97 | 
> | 
    void setGlobalIndex(SimInfo* info); | 
| 98 | 
  | 
 | 
| 99 | 
< | 
        void gatherParameters(SimInfo *info, const std::string& mdfile);              | 
| 106 | 
< | 
 | 
| 99 | 
> | 
    void gatherParameters(SimInfo *info, const std::string& mdfile);              | 
| 100 | 
  | 
         | 
| 101 | 
< | 
        /** Extracts the molecules stamps and adds them into SimInfo class */ | 
| 102 | 
< | 
        void compList(MakeStamps* stamps,  Globals* simParams,  | 
| 103 | 
< | 
                                     std::vector<std::pair<MoleculeStamp*, int> >& moleculeStamps) ; | 
| 111 | 
< | 
 | 
| 112 | 
< | 
        /** | 
| 113 | 
< | 
         * Divide the molecules among the processors  | 
| 114 | 
< | 
         */ | 
| 101 | 
> | 
    /** | 
| 102 | 
> | 
     * Divide the molecules among the processors  | 
| 103 | 
> | 
     */ | 
| 104 | 
  | 
          | 
| 105 | 
< | 
        void divideMolecules(SimInfo* info); | 
| 105 | 
> | 
    void divideMolecules(SimInfo* info); | 
| 106 | 
  | 
 | 
| 107 | 
< | 
        /** Load initial coordinates */ | 
| 108 | 
< | 
        void loadCoordinates(SimInfo* info);      | 
| 107 | 
> | 
    /** Load initial coordinates */ | 
| 108 | 
> | 
    void loadCoordinates(SimInfo* info);      | 
| 109 | 
  | 
 | 
| 110 | 
< | 
        std::string mdFileName_;  //save the meta-data file name which may be used later | 
| 111 | 
< | 
}; | 
| 110 | 
> | 
    std::string mdFileName_;  //save the meta-data file name which may be used later | 
| 111 | 
> | 
  }; | 
| 112 | 
  | 
 | 
| 113 | 
  | 
} //end namespace oopse | 
| 114 | 
  | 
#endif //BRAINS_SIMCREATOR_HPP |