ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/OOPSE-3.0/src/brains/SimCreator.cpp
Revision: 2101
Committed: Thu Mar 10 15:10:24 2005 UTC (19 years, 4 months ago) by chrisfen
File size: 20267 byte(s)
Log Message:
First commit of the new restraints code

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(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
182 //load initial coordinates, some extra information are pushed into SimInfo's property map ( such as
183 //eta, chi for NPT integrator)
184 if (loadInitCoords)
185 loadCoordinates(info);
186
187 return info;
188 }
189
190 void SimCreator::gatherParameters(SimInfo *info, const std::string& mdfile) {
191
192 //figure out the ouput file names
193 std::string prefix;
194
195 #ifdef IS_MPI
196
197 if (worldRank == 0) {
198 #endif // is_mpi
199 Globals * simParams = info->getSimParams();
200 if (simParams->haveFinalConfig()) {
201 prefix = getPrefix(simParams->getFinalConfig());
202 } else {
203 prefix = getPrefix(mdfile);
204 }
205
206 info->setFinalConfigFileName(prefix + ".eor");
207 info->setDumpFileName(prefix + ".dump");
208 info->setStatFileName(prefix + ".stat");
209 info->setRestFileName(prefix + ".zang");
210
211 #ifdef IS_MPI
212
213 }
214
215 #endif
216
217 }
218
219 #ifdef IS_MPI
220 void SimCreator::divideMolecules(SimInfo *info) {
221 double numerator;
222 double denominator;
223 double precast;
224 double x;
225 double y;
226 double a;
227 int old_atoms;
228 int add_atoms;
229 int new_atoms;
230 int nTarget;
231 int done;
232 int i;
233 int j;
234 int loops;
235 int which_proc;
236 int nProcessors;
237 std::vector<int> atomsPerProc;
238 int nGlobalMols = info->getNGlobalMolecules();
239 std::vector<int> molToProcMap(nGlobalMols, -1); // default to an error condition:
240
241 MPI_Comm_size(MPI_COMM_WORLD, &nProcessors);
242
243 if (nProcessors > nGlobalMols) {
244 sprintf(painCave.errMsg,
245 "nProcessors (%d) > nMol (%d)\n"
246 "\tThe number of processors is larger than\n"
247 "\tthe number of molecules. This will not result in a \n"
248 "\tusable division of atoms for force decomposition.\n"
249 "\tEither try a smaller number of processors, or run the\n"
250 "\tsingle-processor version of OOPSE.\n", nProcessors, nGlobalMols);
251
252 painCave.isFatal = 1;
253 simError();
254 }
255
256 int seedValue;
257 Globals * simParams = info->getSimParams();
258 SeqRandNumGen* myRandom; //divide labor does not need Parallel random number generator
259 if (simParams->haveSeed()) {
260 seedValue = simParams->getSeed();
261 myRandom = new SeqRandNumGen(seedValue);
262 }else {
263 myRandom = new SeqRandNumGen();
264 }
265
266
267 a = 3.0 * nGlobalMols / info->getNGlobalAtoms();
268
269 //initialize atomsPerProc
270 atomsPerProc.insert(atomsPerProc.end(), nProcessors, 0);
271
272 if (worldRank == 0) {
273 numerator = info->getNGlobalAtoms();
274 denominator = nProcessors;
275 precast = numerator / denominator;
276 nTarget = (int)(precast + 0.5);
277
278 for(i = 0; i < nGlobalMols; i++) {
279 done = 0;
280 loops = 0;
281
282 while (!done) {
283 loops++;
284
285 // Pick a processor at random
286
287 which_proc = (int) (myRandom->rand() * nProcessors);
288
289 //get the molecule stamp first
290 int stampId = info->getMoleculeStampId(i);
291 MoleculeStamp * moleculeStamp = info->getMoleculeStamp(stampId);
292
293 // How many atoms does this processor have so far?
294 old_atoms = atomsPerProc[which_proc];
295 add_atoms = moleculeStamp->getNAtoms();
296 new_atoms = old_atoms + add_atoms;
297
298 // If we've been through this loop too many times, we need
299 // to just give up and assign the molecule to this processor
300 // and be done with it.
301
302 if (loops > 100) {
303 sprintf(painCave.errMsg,
304 "I've tried 100 times to assign molecule %d to a "
305 " processor, but can't find a good spot.\n"
306 "I'm assigning it at random to processor %d.\n",
307 i, which_proc);
308
309 painCave.isFatal = 0;
310 simError();
311
312 molToProcMap[i] = which_proc;
313 atomsPerProc[which_proc] += add_atoms;
314
315 done = 1;
316 continue;
317 }
318
319 // If we can add this molecule to this processor without sending
320 // it above nTarget, then go ahead and do it:
321
322 if (new_atoms <= nTarget) {
323 molToProcMap[i] = which_proc;
324 atomsPerProc[which_proc] += add_atoms;
325
326 done = 1;
327 continue;
328 }
329
330 // The only situation left is when new_atoms > nTarget. We
331 // want to accept this with some probability that dies off the
332 // farther we are from nTarget
333
334 // roughly: x = new_atoms - nTarget
335 // Pacc(x) = exp(- a * x)
336 // where a = penalty / (average atoms per molecule)
337
338 x = (double)(new_atoms - nTarget);
339 y = myRandom->rand();
340
341 if (y < exp(- a * x)) {
342 molToProcMap[i] = which_proc;
343 atomsPerProc[which_proc] += add_atoms;
344
345 done = 1;
346 continue;
347 } else {
348 continue;
349 }
350 }
351 }
352
353 delete myRandom;
354
355 // Spray out this nonsense to all other processors:
356
357 MPI_Bcast(&molToProcMap[0], nGlobalMols, MPI_INT, 0, MPI_COMM_WORLD);
358 } else {
359
360 // Listen to your marching orders from processor 0:
361
362 MPI_Bcast(&molToProcMap[0], nGlobalMols, MPI_INT, 0, MPI_COMM_WORLD);
363 }
364
365 info->setMolToProcMap(molToProcMap);
366 sprintf(checkPointMsg,
367 "Successfully divided the molecules among the processors.\n");
368 MPIcheckPoint();
369 }
370
371 #endif
372
373 void SimCreator::createMolecules(SimInfo *info) {
374 MoleculeCreator molCreator;
375 int stampId;
376
377 for(int i = 0; i < info->getNGlobalMolecules(); i++) {
378
379 #ifdef IS_MPI
380
381 if (info->getMolToProc(i) == worldRank) {
382 #endif
383
384 stampId = info->getMoleculeStampId(i);
385 Molecule * mol = molCreator.createMolecule(info->getForceField(), info->getMoleculeStamp(stampId),
386 stampId, i, info->getLocalIndexManager());
387
388 info->addMolecule(mol);
389
390 #ifdef IS_MPI
391
392 }
393
394 #endif
395
396 } //end for(int i=0)
397 }
398
399 void SimCreator::compList(MakeStamps *stamps, Globals* simParams,
400 std::vector < std::pair<MoleculeStamp *, int> > &moleculeStampPairs) {
401 int i;
402 char * id;
403 LinkedMolStamp* extractedStamp = NULL;
404 MoleculeStamp * currentStamp;
405 Component** the_components = simParams->getComponents();
406 int n_components = simParams->getNComponents();
407
408 if (!simParams->haveNMol()) {
409 // we don't have the total number of molecules, so we assume it is
410 // given in each component
411
412 for(i = 0; i < n_components; i++) {
413 if (!the_components[i]->haveNMol()) {
414 // we have a problem
415 sprintf(painCave.errMsg,
416 "SimCreator Error. No global NMol or component NMol given.\n"
417 "\tCannot calculate the number of atoms.\n");
418
419 painCave.isFatal = 1;
420 simError();
421 }
422
423 id = the_components[i]->getType();
424
425 extractedStamp = stamps->extractMolStamp(id);
426 if (extractedStamp == NULL) {
427 sprintf(painCave.errMsg,
428 "SimCreator error: Component \"%s\" was not found in the "
429 "list of declared molecules\n", id);
430
431 painCave.isFatal = 1;
432 simError();
433 }
434
435 currentStamp = extractedStamp->getStamp();
436
437
438 moleculeStampPairs.push_back(
439 std::make_pair(currentStamp, the_components[i]->getNMol()));
440 } //end for (i = 0; i < n_components; i++)
441 } else {
442 sprintf(painCave.errMsg, "SimSetup error.\n"
443 "\tSorry, the ability to specify total"
444 " nMols and then give molfractions in the components\n"
445 "\tis not currently supported."
446 " Please give nMol in the components.\n");
447
448 painCave.isFatal = 1;
449 simError();
450 }
451
452 #ifdef IS_MPI
453
454 strcpy(checkPointMsg, "Component stamps successfully extracted\n");
455 MPIcheckPoint();
456
457 #endif // is_mpi
458
459 }
460
461 void SimCreator::setGlobalIndex(SimInfo *info) {
462 SimInfo::MoleculeIterator mi;
463 Molecule::AtomIterator ai;
464 Molecule::RigidBodyIterator ri;
465 Molecule::CutoffGroupIterator ci;
466 Molecule * mol;
467 Atom * atom;
468 RigidBody * rb;
469 CutoffGroup * cg;
470 int beginAtomIndex;
471 int beginRigidBodyIndex;
472 int beginCutoffGroupIndex;
473 int nGlobalAtoms = info->getNGlobalAtoms();
474
475 #ifndef IS_MPI
476
477 beginAtomIndex = 0;
478 beginRigidBodyIndex = 0;
479 beginCutoffGroupIndex = 0;
480
481 #else
482
483 int nproc;
484 int myNode;
485
486 myNode = worldRank;
487 MPI_Comm_size(MPI_COMM_WORLD, &nproc);
488
489 std::vector < int > tmpAtomsInProc(nproc, 0);
490 std::vector < int > tmpRigidBodiesInProc(nproc, 0);
491 std::vector < int > tmpCutoffGroupsInProc(nproc, 0);
492 std::vector < int > NumAtomsInProc(nproc, 0);
493 std::vector < int > NumRigidBodiesInProc(nproc, 0);
494 std::vector < int > NumCutoffGroupsInProc(nproc, 0);
495
496 tmpAtomsInProc[myNode] = info->getNAtoms();
497 tmpRigidBodiesInProc[myNode] = info->getNRigidBodies();
498 tmpCutoffGroupsInProc[myNode] = info->getNCutoffGroups();
499
500 //do MPI_ALLREDUCE to exchange the total number of atoms, rigidbodies and cutoff groups
501 MPI_Allreduce(&tmpAtomsInProc[0], &NumAtomsInProc[0], nproc, MPI_INT,
502 MPI_SUM, MPI_COMM_WORLD);
503 MPI_Allreduce(&tmpRigidBodiesInProc[0], &NumRigidBodiesInProc[0], nproc,
504 MPI_INT, MPI_SUM, MPI_COMM_WORLD);
505 MPI_Allreduce(&tmpCutoffGroupsInProc[0], &NumCutoffGroupsInProc[0], nproc,
506 MPI_INT, MPI_SUM, MPI_COMM_WORLD);
507
508 beginAtomIndex = 0;
509 beginRigidBodyIndex = 0;
510 beginCutoffGroupIndex = 0;
511
512 for(int i = 0; i < myNode; i++) {
513 beginAtomIndex += NumAtomsInProc[i];
514 beginRigidBodyIndex += NumRigidBodiesInProc[i];
515 beginCutoffGroupIndex += NumCutoffGroupsInProc[i];
516 }
517
518 #endif
519
520 //rigidbody's index begins right after atom's
521 beginRigidBodyIndex += info->getNGlobalAtoms();
522
523 for(mol = info->beginMolecule(mi); mol != NULL;
524 mol = info->nextMolecule(mi)) {
525
526 //local index(index in DataStorge) of atom is important
527 for(atom = mol->beginAtom(ai); atom != NULL; atom = mol->nextAtom(ai)) {
528 atom->setGlobalIndex(beginAtomIndex++);
529 }
530
531 for(rb = mol->beginRigidBody(ri); rb != NULL;
532 rb = mol->nextRigidBody(ri)) {
533 rb->setGlobalIndex(beginRigidBodyIndex++);
534 }
535
536 //local index of cutoff group is trivial, it only depends on the order of travesing
537 for(cg = mol->beginCutoffGroup(ci); cg != NULL;
538 cg = mol->nextCutoffGroup(ci)) {
539 cg->setGlobalIndex(beginCutoffGroupIndex++);
540 }
541 }
542
543 //fill globalGroupMembership
544 std::vector<int> globalGroupMembership(info->getNGlobalAtoms(), 0);
545 for(mol = info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
546 for (cg = mol->beginCutoffGroup(ci); cg != NULL; cg = mol->nextCutoffGroup(ci)) {
547
548 for(atom = cg->beginAtom(ai); atom != NULL; atom = cg->nextAtom(ai)) {
549 globalGroupMembership[atom->getGlobalIndex()] = cg->getGlobalIndex();
550 }
551
552 }
553 }
554
555 #ifdef IS_MPI
556 // Since the globalGroupMembership has been zero filled and we've only
557 // poked values into the atoms we know, we can do an Allreduce
558 // to get the full globalGroupMembership array (We think).
559 // This would be prettier if we could use MPI_IN_PLACE like the MPI-2
560 // docs said we could.
561 std::vector<int> tmpGroupMembership(nGlobalAtoms, 0);
562 MPI_Allreduce(&globalGroupMembership[0], &tmpGroupMembership[0], nGlobalAtoms,
563 MPI_INT, MPI_SUM, MPI_COMM_WORLD);
564 info->setGlobalGroupMembership(tmpGroupMembership);
565 #else
566 info->setGlobalGroupMembership(globalGroupMembership);
567 #endif
568
569 //fill molMembership
570 std::vector<int> globalMolMembership(info->getNGlobalAtoms(), 0);
571
572 for(mol = info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
573
574 for(atom = mol->beginAtom(ai); atom != NULL; atom = mol->nextAtom(ai)) {
575 globalMolMembership[atom->getGlobalIndex()] = mol->getGlobalIndex();
576 }
577 }
578
579 #ifdef IS_MPI
580 std::vector<int> tmpMolMembership(nGlobalAtoms, 0);
581
582 MPI_Allreduce(&globalMolMembership[0], &tmpMolMembership[0], nGlobalAtoms,
583 MPI_INT, MPI_SUM, MPI_COMM_WORLD);
584
585 info->setGlobalMolMembership(tmpMolMembership);
586 #else
587 info->setGlobalMolMembership(globalMolMembership);
588 #endif
589
590 }
591
592 void SimCreator::loadCoordinates(SimInfo* info) {
593 Globals* simParams;
594 simParams = info->getSimParams();
595
596 if (!simParams->haveInitialConfig()) {
597 sprintf(painCave.errMsg,
598 "Cannot intialize a simulation without an initial configuration file.\n");
599 painCave.isFatal = 1;;
600 simError();
601 }
602
603 DumpReader reader(info, simParams->getInitialConfig());
604 int nframes = reader.getNFrames();
605
606 if (nframes > 0) {
607 reader.readFrame(nframes - 1);
608 } else {
609 //invalid initial coordinate file
610 sprintf(painCave.errMsg,
611 "Initial configuration file %s should at least contain one frame\n",
612 simParams->getInitialConfig());
613 painCave.isFatal = 1;
614 simError();
615 }
616
617 //copy the current snapshot to previous snapshot
618 info->getSnapshotManager()->advance();
619 }
620
621 } //end namespace oopse
622
623