ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/OOPSE-4/src/brains/SimCreator.cpp
Revision: 2187
Committed: Wed Apr 13 18:41:17 2005 UTC (19 years, 2 months ago) by tim
File size: 20004 byte(s)
Log Message:
more memory leak are fixed

File Contents

# Content
1 /*
2 * 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 * 1. Acknowledgement of the program authors must be made in any
10 * publication of scientific results based in part on use of the
11 * program. An acceptable form of acknowledgement is citation of
12 * the article in which the program was described (Matthew
13 * A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14 * J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15 * Parallel Simulation Engine for Molecular Dynamics,"
16 * J. Comput. Chem. 26, pp. 252-271 (2005))
17 *
18 * 2. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 *
21 * 3. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the
24 * distribution.
25 *
26 * This software is provided "AS IS," without a warranty of any
27 * kind. All express or implied conditions, representations and
28 * warranties, including any implied warranty of merchantability,
29 * fitness for a particular purpose or non-infringement, are hereby
30 * excluded. The University of Notre Dame and its licensors shall not
31 * be liable for any damages suffered by licensee as a result of
32 * using, modifying or distributing the software or its
33 * derivatives. In no event will the University of Notre Dame or its
34 * licensors be liable for any lost revenue, profit or data, or for
35 * direct, indirect, special, consequential, incidental or punitive
36 * damages, however caused and regardless of the theory of liability,
37 * arising out of the use of or inability to use software, even if the
38 * University of Notre Dame has been advised of the possibility of
39 * such damages.
40 */
41
42 /**
43 * @file SimCreator.cpp
44 * @author tlin
45 * @date 11/03/2004
46 * @time 13:51am
47 * @version 1.0
48 */
49
50 #include "brains/MoleculeCreator.hpp"
51 #include "brains/SimCreator.hpp"
52 #include "brains/SimSnapshotManager.hpp"
53 #include "io/DumpReader.hpp"
54 #include "io/parse_me.h"
55 #include "UseTheForce/ForceFieldFactory.hpp"
56 #include "utils/simError.h"
57 #include "utils/StringUtils.hpp"
58 #include "math/SeqRandNumGen.hpp"
59 #ifdef IS_MPI
60 #include "io/mpiBASS.h"
61 #include "math/ParallelRandNumGen.hpp"
62 #endif
63
64 namespace oopse {
65
66 void SimCreator::parseFile(const std::string mdFileName, MakeStamps* stamps,
67 Globals* simParams){
68
69 #ifdef IS_MPI
70
71 if (worldRank == 0) {
72 #endif // is_mpi
73
74 simParams->initalize();
75 set_interface_stamps(stamps, simParams);
76
77 #ifdef IS_MPI
78
79 mpiEventInit();
80
81 #endif
82
83 yacc_BASS(mdFileName.c_str());
84
85 #ifdef IS_MPI
86
87 throwMPIEvent(NULL);
88 } else {
89 set_interface_stamps(stamps, simParams);
90 mpiEventInit();
91 MPIcheckPoint();
92 mpiEventLoop();
93 }
94
95 #endif
96
97 }
98
99 SimInfo* SimCreator::createSim(const std::string & mdFileName, bool loadInitCoords) {
100
101 MakeStamps * stamps = new MakeStamps();
102
103 Globals * simParams = new Globals();
104
105 //parse meta-data file
106 parseFile(mdFileName, stamps, simParams);
107
108 //create the force field
109 ForceField * ff = ForceFieldFactory::getInstance()->createForceField(
110 simParams->getForceField());
111
112 if (ff == NULL) {
113 sprintf(painCave.errMsg, "ForceField Factory can not create %s force field\n",
114 simParams->getForceField());
115 painCave.isFatal = 1;
116 simError();
117 }
118
119 if (simParams->haveForceFieldFileName()) {
120 ff->setForceFieldFileName(simParams->getForceFieldFileName());
121 }
122
123 std::string forcefieldFileName;
124 forcefieldFileName = ff->getForceFieldFileName();
125
126 if (simParams->haveForceFieldVariant()) {
127 //If the force field has variant, the variant force field name will be
128 //Base.variant.frc. For exampel EAM.u6.frc
129
130 std::string variant = simParams->getForceFieldVariant();
131
132 std::string::size_type pos = forcefieldFileName.rfind(".frc");
133 variant = "." + variant;
134 if (pos != std::string::npos) {
135 forcefieldFileName.insert(pos, variant);
136 } else {
137 //If the default force field file name does not containt .frc suffix, just append the .variant
138 forcefieldFileName.append(variant);
139 }
140 }
141
142 ff->parse(forcefieldFileName);
143
144 //extract the molecule stamps
145 std::vector < std::pair<MoleculeStamp *, int> > moleculeStampPairs;
146 compList(stamps, simParams, moleculeStampPairs);
147
148 //create SimInfo
149 SimInfo * info = new SimInfo(stamps, moleculeStampPairs, ff, simParams);
150
151 //gather parameters (SimCreator only retrieves part of the parameters)
152 gatherParameters(info, mdFileName);
153
154 //divide the molecules and determine the global index of molecules
155 #ifdef IS_MPI
156 divideMolecules(info);
157 #endif
158
159 //create the molecules
160 createMolecules(info);
161
162
163 //allocate memory for DataStorage(circular reference, need to break it)
164 info->setSnapshotManager(new SimSnapshotManager(info));
165
166 //set the global index of atoms, rigidbodies and cutoffgroups (only need to be set once, the
167 //global index will never change again). Local indices of atoms and rigidbodies are already set by
168 //MoleculeCreator class which actually delegates the responsibility to LocalIndexManager.
169 setGlobalIndex(info);
170
171 //Alought addExculdePairs is called inside SimInfo's addMolecule method, at that point
172 //atoms don't have the global index yet (their global index are all initialized to -1).
173 //Therefore we have to call addExcludePairs explicitly here. A way to work around is that
174 //we can determine the beginning global indices of atoms before they get created.
175 SimInfo::MoleculeIterator mi;
176 Molecule* mol;
177 for (mol= info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
178 info->addExcludePairs(mol);
179 }
180
181 if (loadInitCoords)
182 loadCoordinates(info);
183
184 return info;
185 }
186
187 void SimCreator::gatherParameters(SimInfo *info, const std::string& mdfile) {
188
189 //figure out the ouput file names
190 std::string prefix;
191
192 #ifdef IS_MPI
193
194 if (worldRank == 0) {
195 #endif // is_mpi
196 Globals * simParams = info->getSimParams();
197 if (simParams->haveFinalConfig()) {
198 prefix = getPrefix(simParams->getFinalConfig());
199 } else {
200 prefix = getPrefix(mdfile);
201 }
202
203 info->setFinalConfigFileName(prefix + ".eor");
204 info->setDumpFileName(prefix + ".dump");
205 info->setStatFileName(prefix + ".stat");
206 info->setRestFileName(prefix + ".zang");
207
208 #ifdef IS_MPI
209
210 }
211
212 #endif
213
214 }
215
216 #ifdef IS_MPI
217 void SimCreator::divideMolecules(SimInfo *info) {
218 double numerator;
219 double denominator;
220 double precast;
221 double x;
222 double y;
223 double a;
224 int old_atoms;
225 int add_atoms;
226 int new_atoms;
227 int nTarget;
228 int done;
229 int i;
230 int j;
231 int loops;
232 int which_proc;
233 int nProcessors;
234 std::vector<int> atomsPerProc;
235 int nGlobalMols = info->getNGlobalMolecules();
236 std::vector<int> molToProcMap(nGlobalMols, -1); // default to an error condition:
237
238 MPI_Comm_size(MPI_COMM_WORLD, &nProcessors);
239
240 if (nProcessors > nGlobalMols) {
241 sprintf(painCave.errMsg,
242 "nProcessors (%d) > nMol (%d)\n"
243 "\tThe number of processors is larger than\n"
244 "\tthe number of molecules. This will not result in a \n"
245 "\tusable division of atoms for force decomposition.\n"
246 "\tEither try a smaller number of processors, or run the\n"
247 "\tsingle-processor version of OOPSE.\n", nProcessors, nGlobalMols);
248
249 painCave.isFatal = 1;
250 simError();
251 }
252
253 int seedValue;
254 Globals * simParams = info->getSimParams();
255 SeqRandNumGen* myRandom; //divide labor does not need Parallel random number generator
256 if (simParams->haveSeed()) {
257 seedValue = simParams->getSeed();
258 myRandom = new SeqRandNumGen(seedValue);
259 }else {
260 myRandom = new SeqRandNumGen();
261 }
262
263
264 a = 3.0 * nGlobalMols / info->getNGlobalAtoms();
265
266 //initialize atomsPerProc
267 atomsPerProc.insert(atomsPerProc.end(), nProcessors, 0);
268
269 if (worldRank == 0) {
270 numerator = info->getNGlobalAtoms();
271 denominator = nProcessors;
272 precast = numerator / denominator;
273 nTarget = (int)(precast + 0.5);
274
275 for(i = 0; i < nGlobalMols; i++) {
276 done = 0;
277 loops = 0;
278
279 while (!done) {
280 loops++;
281
282 // Pick a processor at random
283
284 which_proc = (int) (myRandom->rand() * nProcessors);
285
286 //get the molecule stamp first
287 int stampId = info->getMoleculeStampId(i);
288 MoleculeStamp * moleculeStamp = info->getMoleculeStamp(stampId);
289
290 // How many atoms does this processor have so far?
291 old_atoms = atomsPerProc[which_proc];
292 add_atoms = moleculeStamp->getNAtoms();
293 new_atoms = old_atoms + add_atoms;
294
295 // If we've been through this loop too many times, we need
296 // to just give up and assign the molecule to this processor
297 // and be done with it.
298
299 if (loops > 100) {
300 sprintf(painCave.errMsg,
301 "I've tried 100 times to assign molecule %d to a "
302 " processor, but can't find a good spot.\n"
303 "I'm assigning it at random to processor %d.\n",
304 i, which_proc);
305
306 painCave.isFatal = 0;
307 simError();
308
309 molToProcMap[i] = which_proc;
310 atomsPerProc[which_proc] += add_atoms;
311
312 done = 1;
313 continue;
314 }
315
316 // If we can add this molecule to this processor without sending
317 // it above nTarget, then go ahead and do it:
318
319 if (new_atoms <= nTarget) {
320 molToProcMap[i] = which_proc;
321 atomsPerProc[which_proc] += add_atoms;
322
323 done = 1;
324 continue;
325 }
326
327 // The only situation left is when new_atoms > nTarget. We
328 // want to accept this with some probability that dies off the
329 // farther we are from nTarget
330
331 // roughly: x = new_atoms - nTarget
332 // Pacc(x) = exp(- a * x)
333 // where a = penalty / (average atoms per molecule)
334
335 x = (double)(new_atoms - nTarget);
336 y = myRandom->rand();
337
338 if (y < exp(- a * x)) {
339 molToProcMap[i] = which_proc;
340 atomsPerProc[which_proc] += add_atoms;
341
342 done = 1;
343 continue;
344 } else {
345 continue;
346 }
347 }
348 }
349
350 delete myRandom;
351
352 // Spray out this nonsense to all other processors:
353
354 MPI_Bcast(&molToProcMap[0], nGlobalMols, MPI_INT, 0, MPI_COMM_WORLD);
355 } else {
356
357 // Listen to your marching orders from processor 0:
358
359 MPI_Bcast(&molToProcMap[0], nGlobalMols, MPI_INT, 0, MPI_COMM_WORLD);
360 }
361
362 info->setMolToProcMap(molToProcMap);
363 sprintf(checkPointMsg,
364 "Successfully divided the molecules among the processors.\n");
365 MPIcheckPoint();
366 }
367
368 #endif
369
370 void SimCreator::createMolecules(SimInfo *info) {
371 MoleculeCreator molCreator;
372 int stampId;
373
374 for(int i = 0; i < info->getNGlobalMolecules(); i++) {
375
376 #ifdef IS_MPI
377
378 if (info->getMolToProc(i) == worldRank) {
379 #endif
380
381 stampId = info->getMoleculeStampId(i);
382 Molecule * mol = molCreator.createMolecule(info->getForceField(), info->getMoleculeStamp(stampId),
383 stampId, i, info->getLocalIndexManager());
384
385 info->addMolecule(mol);
386
387 #ifdef IS_MPI
388
389 }
390
391 #endif
392
393 } //end for(int i=0)
394 }
395
396 void SimCreator::compList(MakeStamps *stamps, Globals* simParams,
397 std::vector < std::pair<MoleculeStamp *, int> > &moleculeStampPairs) {
398 int i;
399 char * id;
400 MoleculeStamp * currentStamp;
401 Component** the_components = simParams->getComponents();
402 int n_components = simParams->getNComponents();
403
404 if (!simParams->haveNMol()) {
405 // we don't have the total number of molecules, so we assume it is
406 // given in each component
407
408 for(i = 0; i < n_components; i++) {
409 if (!the_components[i]->haveNMol()) {
410 // we have a problem
411 sprintf(painCave.errMsg,
412 "SimCreator Error. No global NMol or component NMol given.\n"
413 "\tCannot calculate the number of atoms.\n");
414
415 painCave.isFatal = 1;
416 simError();
417 }
418
419 id = the_components[i]->getType();
420
421 currentStamp = stamps->getMolStamp(id);
422 if (currentStamp == NULL) {
423 sprintf(painCave.errMsg,
424 "SimCreator error: Component \"%s\" was not found in the "
425 "list of declared molecules\n", id);
426
427 painCave.isFatal = 1;
428 simError();
429 }
430
431 moleculeStampPairs.push_back(
432 std::make_pair(currentStamp, the_components[i]->getNMol()));
433 } //end for (i = 0; i < n_components; i++)
434 } else {
435 sprintf(painCave.errMsg, "SimSetup error.\n"
436 "\tSorry, the ability to specify total"
437 " nMols and then give molfractions in the components\n"
438 "\tis not currently supported."
439 " Please give nMol in the components.\n");
440
441 painCave.isFatal = 1;
442 simError();
443 }
444
445 #ifdef IS_MPI
446
447 strcpy(checkPointMsg, "Component stamps successfully extracted\n");
448 MPIcheckPoint();
449
450 #endif // is_mpi
451
452 }
453
454 void SimCreator::setGlobalIndex(SimInfo *info) {
455 SimInfo::MoleculeIterator mi;
456 Molecule::AtomIterator ai;
457 Molecule::RigidBodyIterator ri;
458 Molecule::CutoffGroupIterator ci;
459 Molecule * mol;
460 Atom * atom;
461 RigidBody * rb;
462 CutoffGroup * cg;
463 int beginAtomIndex;
464 int beginRigidBodyIndex;
465 int beginCutoffGroupIndex;
466 int nGlobalAtoms = info->getNGlobalAtoms();
467
468 #ifndef IS_MPI
469
470 beginAtomIndex = 0;
471 beginRigidBodyIndex = 0;
472 beginCutoffGroupIndex = 0;
473
474 #else
475
476 int nproc;
477 int myNode;
478
479 myNode = worldRank;
480 MPI_Comm_size(MPI_COMM_WORLD, &nproc);
481
482 std::vector < int > tmpAtomsInProc(nproc, 0);
483 std::vector < int > tmpRigidBodiesInProc(nproc, 0);
484 std::vector < int > tmpCutoffGroupsInProc(nproc, 0);
485 std::vector < int > NumAtomsInProc(nproc, 0);
486 std::vector < int > NumRigidBodiesInProc(nproc, 0);
487 std::vector < int > NumCutoffGroupsInProc(nproc, 0);
488
489 tmpAtomsInProc[myNode] = info->getNAtoms();
490 tmpRigidBodiesInProc[myNode] = info->getNRigidBodies();
491 tmpCutoffGroupsInProc[myNode] = info->getNCutoffGroups();
492
493 //do MPI_ALLREDUCE to exchange the total number of atoms, rigidbodies and cutoff groups
494 MPI_Allreduce(&tmpAtomsInProc[0], &NumAtomsInProc[0], nproc, MPI_INT,
495 MPI_SUM, MPI_COMM_WORLD);
496 MPI_Allreduce(&tmpRigidBodiesInProc[0], &NumRigidBodiesInProc[0], nproc,
497 MPI_INT, MPI_SUM, MPI_COMM_WORLD);
498 MPI_Allreduce(&tmpCutoffGroupsInProc[0], &NumCutoffGroupsInProc[0], nproc,
499 MPI_INT, MPI_SUM, MPI_COMM_WORLD);
500
501 beginAtomIndex = 0;
502 beginRigidBodyIndex = 0;
503 beginCutoffGroupIndex = 0;
504
505 for(int i = 0; i < myNode; i++) {
506 beginAtomIndex += NumAtomsInProc[i];
507 beginRigidBodyIndex += NumRigidBodiesInProc[i];
508 beginCutoffGroupIndex += NumCutoffGroupsInProc[i];
509 }
510
511 #endif
512
513 //rigidbody's index begins right after atom's
514 beginRigidBodyIndex += info->getNGlobalAtoms();
515
516 for(mol = info->beginMolecule(mi); mol != NULL;
517 mol = info->nextMolecule(mi)) {
518
519 //local index(index in DataStorge) of atom is important
520 for(atom = mol->beginAtom(ai); atom != NULL; atom = mol->nextAtom(ai)) {
521 atom->setGlobalIndex(beginAtomIndex++);
522 }
523
524 for(rb = mol->beginRigidBody(ri); rb != NULL;
525 rb = mol->nextRigidBody(ri)) {
526 rb->setGlobalIndex(beginRigidBodyIndex++);
527 }
528
529 //local index of cutoff group is trivial, it only depends on the order of travesing
530 for(cg = mol->beginCutoffGroup(ci); cg != NULL;
531 cg = mol->nextCutoffGroup(ci)) {
532 cg->setGlobalIndex(beginCutoffGroupIndex++);
533 }
534 }
535
536 //fill globalGroupMembership
537 std::vector<int> globalGroupMembership(info->getNGlobalAtoms(), 0);
538 for(mol = info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
539 for (cg = mol->beginCutoffGroup(ci); cg != NULL; cg = mol->nextCutoffGroup(ci)) {
540
541 for(atom = cg->beginAtom(ai); atom != NULL; atom = cg->nextAtom(ai)) {
542 globalGroupMembership[atom->getGlobalIndex()] = cg->getGlobalIndex();
543 }
544
545 }
546 }
547
548 #ifdef IS_MPI
549 // Since the globalGroupMembership has been zero filled and we've only
550 // poked values into the atoms we know, we can do an Allreduce
551 // to get the full globalGroupMembership array (We think).
552 // This would be prettier if we could use MPI_IN_PLACE like the MPI-2
553 // docs said we could.
554 std::vector<int> tmpGroupMembership(nGlobalAtoms, 0);
555 MPI_Allreduce(&globalGroupMembership[0], &tmpGroupMembership[0], nGlobalAtoms,
556 MPI_INT, MPI_SUM, MPI_COMM_WORLD);
557 info->setGlobalGroupMembership(tmpGroupMembership);
558 #else
559 info->setGlobalGroupMembership(globalGroupMembership);
560 #endif
561
562 //fill molMembership
563 std::vector<int> globalMolMembership(info->getNGlobalAtoms(), 0);
564
565 for(mol = info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
566
567 for(atom = mol->beginAtom(ai); atom != NULL; atom = mol->nextAtom(ai)) {
568 globalMolMembership[atom->getGlobalIndex()] = mol->getGlobalIndex();
569 }
570 }
571
572 #ifdef IS_MPI
573 std::vector<int> tmpMolMembership(nGlobalAtoms, 0);
574
575 MPI_Allreduce(&globalMolMembership[0], &tmpMolMembership[0], nGlobalAtoms,
576 MPI_INT, MPI_SUM, MPI_COMM_WORLD);
577
578 info->setGlobalMolMembership(tmpMolMembership);
579 #else
580 info->setGlobalMolMembership(globalMolMembership);
581 #endif
582
583 }
584
585 void SimCreator::loadCoordinates(SimInfo* info) {
586 Globals* simParams;
587 simParams = info->getSimParams();
588
589 if (!simParams->haveInitialConfig()) {
590 sprintf(painCave.errMsg,
591 "Cannot intialize a simulation without an initial configuration file.\n");
592 painCave.isFatal = 1;;
593 simError();
594 }
595
596 DumpReader reader(info, simParams->getInitialConfig());
597 int nframes = reader.getNFrames();
598
599 if (nframes > 0) {
600 reader.readFrame(nframes - 1);
601 } else {
602 //invalid initial coordinate file
603 sprintf(painCave.errMsg,
604 "Initial configuration file %s should at least contain one frame\n",
605 simParams->getInitialConfig());
606 painCave.isFatal = 1;
607 simError();
608 }
609
610 //copy the current snapshot to previous snapshot
611 info->getSnapshotManager()->advance();
612 }
613
614 } //end namespace oopse
615
616