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 |
63 |
|
|
64 |
|
namespace oopse { |
65 |
|
|
66 |
< |
/** |
67 |
< |
* @class SimCreator SimCreator.hpp "brains/SimCreator.hpp" |
68 |
< |
* The only responsibility of SimCreator is to parse the meta-data file and create a SimInfo |
69 |
< |
* instance based on the information returned by parser. |
70 |
< |
*/ |
71 |
< |
class SimCreator { |
72 |
< |
public: |
66 |
> |
/** |
67 |
> |
* @class SimCreator SimCreator.hpp "brains/SimCreator.hpp" |
68 |
> |
* The only responsibility of SimCreator is to parse the meta-data file and create a SimInfo |
69 |
> |
* instance based on the information returned by parser. |
70 |
> |
*/ |
71 |
> |
class SimCreator { |
72 |
> |
public: |
73 |
|
|
74 |
< |
virtual ~SimCreator() {} |
74 |
> |
virtual ~SimCreator() {} |
75 |
|
|
76 |
< |
/** |
77 |
< |
* Setup Simulation |
78 |
< |
* @return a pointer to SimInfo |
79 |
< |
* @param mdfile the meta-data file name |
80 |
< |
*/ |
81 |
< |
SimInfo* createSim(const std::string & mdFileName, bool loadInitCoords = true); |
76 |
> |
/** |
77 |
> |
* Setup Simulation |
78 |
> |
* @return a pointer to SimInfo |
79 |
> |
* @param mdfile the meta-data file name |
80 |
> |
*/ |
81 |
> |
SimInfo* createSim(const std::string & mdFileName, bool loadInitCoords = true); |
82 |
|
|
83 |
< |
private: |
83 |
> |
private: |
84 |
|
|
85 |
< |
/** |
86 |
< |
* Parses the meta-data file |
87 |
< |
* @param mdfile |
88 |
< |
* @param stamps |
89 |
< |
* @param simParams |
90 |
< |
*/ |
91 |
< |
void parseFile(const std::string mdFileName, MakeStamps* stamps, Globals* simParams); |
85 |
> |
/** |
86 |
> |
* Parses the meta-data file |
87 |
> |
* @param mdfile |
88 |
> |
* @param stamps |
89 |
> |
* @param simParams |
90 |
> |
*/ |
91 |
> |
void parseFile(const std::string mdFileName, MakeStamps* stamps, Globals* simParams); |
92 |
|
|
93 |
|
|
94 |
< |
/** create the molecules belong to current processor*/ |
95 |
< |
virtual void createMolecules(SimInfo* info); |
94 |
> |
/** create the molecules belong to current processor*/ |
95 |
> |
virtual void createMolecules(SimInfo* info); |
96 |
|
|
97 |
< |
/** |
98 |
< |
* Sets the global index for atoms, rigidbodies and cutoff groups and fill up |
99 |
< |
* globalGroupMembership and globalMolMembership arrays which map atoms' |
100 |
< |
* global index to the global index of the groups (or molecules) they belong to. |
101 |
< |
* These array are never changed during the simulation. |
102 |
< |
*/ |
103 |
< |
void setGlobalIndex(SimInfo* info); |
97 |
> |
/** |
98 |
> |
* Sets the global index for atoms, rigidbodies and cutoff groups and fill up |
99 |
> |
* globalGroupMembership and globalMolMembership arrays which map atoms' |
100 |
> |
* global index to the global index of the groups (or molecules) they belong to. |
101 |
> |
* These array are never changed during the simulation. |
102 |
> |
*/ |
103 |
> |
void setGlobalIndex(SimInfo* info); |
104 |
|
|
105 |
< |
void gatherParameters(SimInfo *info, const std::string& mdfile); |
105 |
> |
void gatherParameters(SimInfo *info, const std::string& mdfile); |
106 |
|
|
107 |
|
|
108 |
< |
/** Extracts the molecules stamps and adds them into SimInfo class */ |
109 |
< |
void compList(MakeStamps* stamps, Globals* simParams, |
110 |
< |
std::vector<std::pair<MoleculeStamp*, int> >& moleculeStamps) ; |
108 |
> |
/** Extracts the molecules stamps and adds them into SimInfo class */ |
109 |
> |
void compList(MakeStamps* stamps, Globals* simParams, |
110 |
> |
std::vector<std::pair<MoleculeStamp*, int> >& moleculeStamps) ; |
111 |
|
|
112 |
< |
/** |
113 |
< |
* Divide the molecules among the processors |
114 |
< |
*/ |
112 |
> |
/** |
113 |
> |
* Divide the molecules among the processors |
114 |
> |
*/ |
115 |
|
|
116 |
< |
void divideMolecules(SimInfo* info); |
116 |
> |
void divideMolecules(SimInfo* info); |
117 |
|
|
118 |
< |
/** Load initial coordinates */ |
119 |
< |
void loadCoordinates(SimInfo* info); |
118 |
> |
/** Load initial coordinates */ |
119 |
> |
void loadCoordinates(SimInfo* info); |
120 |
|
|
121 |
< |
std::string mdFileName_; //save the meta-data file name which may be used later |
122 |
< |
}; |
121 |
> |
std::string mdFileName_; //save the meta-data file name which may be used later |
122 |
> |
}; |
123 |
|
|
124 |
|
} //end namespace oopse |
125 |
|
#endif //BRAINS_SIMCREATOR_HPP |