src/brains/SimCreator.cpp

 /*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 */
 
/**
 * @file SimCreator.cpp
 * @author tlin
 * @date 11/03/2004
 * @time 13:51am
 * @version 1.0
 */

#include <sprng.h>

#include "brains/MoleculeCreator.hpp"
#include "brains/SimCreator.hpp"
#include "brains/SimSnapshotManager.hpp"
#include "io/DumpReader.hpp"
#include "io/parse_me.h"
#include "UseTheForce/ForceFieldFactory.hpp"
#include "utils/simError.h"
#include "utils/StringUtils.hpp"
#ifdef IS_MPI
#include "io/mpiBASS.h"
#include "math/randomSPRNG.hpp"
#endif

namespace oopse {

void SimCreator::parseFile(const std::string mdFileName,  MakeStamps* stamps, Globals* simParams){

#ifdef IS_MPI

    if (worldRank == 0) {
#endif // is_mpi

        simParams->initalize();
        set_interface_stamps(stamps, simParams);

#ifdef IS_MPI

        mpiEventInit();

#endif

        yacc_BASS(mdFileName.c_str());

#ifdef IS_MPI

        throwMPIEvent(NULL);
    } else {
        set_interface_stamps(stamps, simParams);
        mpiEventInit();
        MPIcheckPoint();
        mpiEventLoop();
    }

#endif

}

SimInfo*  SimCreator::createSim(const std::string & mdFileName, bool loadInitCoords) {
    
    MakeStamps * stamps = new MakeStamps();

    Globals * simParams = new Globals();

    //parse meta-data file
    parseFile(mdFileName, stamps, simParams);

    //create the force field
    ForceField * ff = ForceFieldFactory::getInstance()->createForceField(
                          simParams->getForceField());
    
    if (ff == NULL) {
        sprintf(painCave.errMsg, "ForceField Factory can not create %s force field\n",
                simParams->getForceField());
        painCave.isFatal = 1;
        simError();
    }

    std::string forcefieldFileName;
    forcefieldFileName = ff->getForceFieldFileName();

    if (simParams->haveForceFieldVariant()) {
        //If the force field has variant, the variant force field name will be
        //Base.variant.frc. For exampel EAM.u6.frc
        
        std::string variant = simParams->getForceFieldVariant();

        std::string::size_type pos = forcefieldFileName.rfind(".frc");
        variant = "." + variant;
        if (pos != std::string::npos) {
            forcefieldFileName.insert(pos, variant);
        } else {
            //If the default force field file name does not containt .frc suffix, just append the .variant
            forcefieldFileName.append(variant);
        }
    } 
    
    ff->parse(forcefieldFileName);
    
    //extract the molecule stamps
    std::vector < std::pair<MoleculeStamp *, int> > moleculeStampPairs;
    compList(stamps, simParams, moleculeStampPairs);

    //create SimInfo
    SimInfo * info = new SimInfo(moleculeStampPairs, ff, simParams);

    //gather parameters (SimCreator only retrieves part of the parameters)
    gatherParameters(info, mdFileName);

    //divide the molecules and determine the global index of molecules
#ifdef IS_MPI
    divideMolecules(info);
#endif 

    //create the molecules
    createMolecules(info);


    //allocate memory for DataStorage(circular reference, need to break it)
    info->setSnapshotManager(new SimSnapshotManager(info));
    
    //set the global index of atoms, rigidbodies and cutoffgroups (only need to be set once, the
    //global index will never change again). Local indices of atoms and rigidbodies are already set by 
    //MoleculeCreator class which actually delegates the responsibility to LocalIndexManager. 
    setGlobalIndex(info);

    //Alought addExculdePairs is called inside SimInfo's addMolecule method, at that point
    //atoms don't have the global index yet  (their global index are all initialized to -1).
    //Therefore we have to call addExcludePairs explicitly here. A way to work around is that
    //we can determine the beginning global indices of atoms before they get created.
    SimInfo::MoleculeIterator mi;
    Molecule* mol;
    for (mol= info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
        info->addExcludePairs(mol);
    }
    

    //load initial coordinates, some extra information are pushed into SimInfo's property map ( such as
    //eta, chi for NPT integrator)
    if (loadInitCoords)
        loadCoordinates(info);    
    
    return info;
}

void SimCreator::gatherParameters(SimInfo *info, const std::string& mdfile) {

    //setup seed for random number generator
    int seedValue;
    Globals * simParams = info->getSimParams();

    if (simParams->haveSeed()) {
        seedValue = simParams->getSeed();

        if (seedValue < 100000000 ) {
            sprintf(painCave.errMsg,
                    "Seed for sprng library should contain at least 9 digits\n"
                        "OOPSE will generate a seed for user\n");

            painCave.isFatal = 0;
            simError();

            //using seed generated by system instead of invalid seed set by user 

#ifndef IS_MPI

            seedValue = make_sprng_seed();

#else

            if (worldRank == 0) {
                seedValue = make_sprng_seed();
            }

            MPI_Bcast(&seedValue, 1, MPI_INT, 0, MPI_COMM_WORLD);

#endif

        } //end if (seedValue /1000000000 == 0)
    } else {

#ifndef IS_MPI

        seedValue = make_sprng_seed();

#else

        if (worldRank == 0) {
            seedValue = make_sprng_seed();
        }

        MPI_Bcast(&seedValue, 1, MPI_INT, 0, MPI_COMM_WORLD);

#endif

    } //end of simParams->haveSeed()

    info->setSeed(seedValue);


    //figure out the ouput file names
    std::string prefix;

#ifdef IS_MPI

    if (worldRank == 0) {
#endif // is_mpi

        if (simParams->haveFinalConfig()) {
            prefix = getPrefix(simParams->getFinalConfig());
        } else {
            prefix = getPrefix(mdfile);
        }

        info->setFinalConfigFileName(prefix + ".eor");
        info->setDumpFileName(prefix + ".dump");
        info->setStatFileName(prefix + ".stat");

#ifdef IS_MPI

    }

#endif

}

#ifdef IS_MPI
void SimCreator::divideMolecules(SimInfo *info) {
    double numerator;
    double denominator;
    double precast;
    double x;
    double y;
    double a;
    int old_atoms;
    int add_atoms;
    int new_atoms;
    int nTarget;
    int done;
    int i;
    int j;
    int loops;
    int which_proc;
    int nProcessors;
    std::vector<int> atomsPerProc;
    randomSPRNG myRandom(info->getSeed());
    int nGlobalMols = info->getNGlobalMolecules();
    std::vector<int> molToProcMap(nGlobalMols, -1); // default to an error condition:
    
    MPI_Comm_size(MPI_COMM_WORLD, &nProcessors);

    if (nProcessors > nGlobalMols) {
        sprintf(painCave.errMsg,
                "nProcessors (%d) > nMol (%d)\n"
                    "\tThe number of processors is larger than\n"
                    "\tthe number of molecules.  This will not result in a \n"
                    "\tusable division of atoms for force decomposition.\n"
                    "\tEither try a smaller number of processors, or run the\n"
                    "\tsingle-processor version of OOPSE.\n", nProcessors, nGlobalMols);

        painCave.isFatal = 1;
        simError();
    }

    a = 3.0 * nGlobalMols / info->getNGlobalAtoms();

    //initialize atomsPerProc
    atomsPerProc.insert(atomsPerProc.end(), nProcessors, 0);

    if (worldRank == 0) {
        numerator = info->getNGlobalAtoms();
        denominator = nProcessors;
        precast = numerator / denominator;
        nTarget = (int)(precast + 0.5);

        for(i = 0; i < nGlobalMols; i++) {
            done = 0;
            loops = 0;

            while (!done) {
                loops++;

                // Pick a processor at random

                which_proc = (int) (myRandom.getRandom() * nProcessors);

                //get the molecule stamp first
                int stampId = info->getMoleculeStampId(i);
                MoleculeStamp * moleculeStamp = info->getMoleculeStamp(stampId);

                // How many atoms does this processor have so far?
                old_atoms = atomsPerProc[which_proc];
                add_atoms = moleculeStamp->getNAtoms();
                new_atoms = old_atoms + add_atoms;

                // If we've been through this loop too many times, we need
                // to just give up and assign the molecule to this processor
                // and be done with it. 

                if (loops > 100) {
                    sprintf(painCave.errMsg,
                            "I've tried 100 times to assign molecule %d to a "
                                " processor, but can't find a good spot.\n"
                                "I'm assigning it at random to processor %d.\n",
                            i, which_proc);

                    painCave.isFatal = 0;
                    simError();

                    molToProcMap[i] = which_proc;
                    atomsPerProc[which_proc] += add_atoms;

                    done = 1;
                    continue;
                }

                // If we can add this molecule to this processor without sending
                // it above nTarget, then go ahead and do it:

                if (new_atoms <= nTarget) {
                    molToProcMap[i] = which_proc;
                    atomsPerProc[which_proc] += add_atoms;

                    done = 1;
                    continue;
                }

                // The only situation left is when new_atoms > nTarget.  We
                // want to accept this with some probability that dies off the
                // farther we are from nTarget

                // roughly:  x = new_atoms - nTarget
                //           Pacc(x) = exp(- a * x)
                // where a = penalty / (average atoms per molecule)

                x = (double)(new_atoms - nTarget);
                y = myRandom.getRandom();

                if (y < exp(- a * x)) {
                    molToProcMap[i] = which_proc;
                    atomsPerProc[which_proc] += add_atoms;

                    done = 1;
                    continue;
                } else {
                    continue;
                }
            }
        }

        // Spray out this nonsense to all other processors:

        MPI_Bcast(&molToProcMap[0], nGlobalMols, MPI_INT, 0, MPI_COMM_WORLD);
    } else {

        // Listen to your marching orders from processor 0:

        MPI_Bcast(&molToProcMap[0], nGlobalMols, MPI_INT, 0, MPI_COMM_WORLD);
    }

    info->setMolToProcMap(molToProcMap);
    sprintf(checkPointMsg,
            "Successfully divided the molecules among the processors.\n");
    MPIcheckPoint();
}

#endif

void SimCreator::createMolecules(SimInfo *info) {
    MoleculeCreator molCreator;
    int stampId;

    for(int i = 0; i < info->getNGlobalMolecules(); i++) {

#ifdef IS_MPI

        if (info->getMolToProc(i) == worldRank) {
#endif

            stampId = info->getMoleculeStampId(i);
            Molecule * mol = molCreator.createMolecule(info->getForceField(), info->getMoleculeStamp(stampId),
                                                                                    stampId, i, info->getLocalIndexManager());

            info->addMolecule(mol);

#ifdef IS_MPI

        }

#endif

    } //end for(int i=0)   
}

void SimCreator::compList(MakeStamps *stamps, Globals* simParams,
                        std::vector < std::pair<MoleculeStamp *, int> > &moleculeStampPairs) {
    int i;
    char * id;
    MoleculeStamp * currentStamp;
    Component** the_components = simParams->getComponents();
    int n_components = simParams->getNComponents();

    if (!simParams->haveNMol()) {
        // we don't have the total number of molecules, so we assume it is
        // given in each component

        for(i = 0; i < n_components; i++) {
            if (!the_components[i]->haveNMol()) {
                // we have a problem
                sprintf(painCave.errMsg,
                        "SimCreator Error. No global NMol or component NMol given.\n"
                            "\tCannot calculate the number of atoms.\n");

                painCave.isFatal = 1;
                simError();
            }

            id = the_components[i]->getType();
            currentStamp = (stamps->extractMolStamp(id))->getStamp();

            if (currentStamp == NULL) {
                sprintf(painCave.errMsg,
                        "SimCreator error: Component \"%s\" was not found in the "
                            "list of declared molecules\n", id);

                painCave.isFatal = 1;
                simError();
            }

            moleculeStampPairs.push_back(
                std::make_pair(currentStamp, the_components[i]->getNMol()));
        } //end for (i = 0; i < n_components; i++)
    } else {
        sprintf(painCave.errMsg, "SimSetup error.\n"
                                     "\tSorry, the ability to specify total"
                                     " nMols and then give molfractions in the components\n"
                                     "\tis not currently supported."
                                     " Please give nMol in the components.\n");

        painCave.isFatal = 1;
        simError();
    }

#ifdef IS_MPI

    strcpy(checkPointMsg, "Component stamps successfully extracted\n");
    MPIcheckPoint();

#endif // is_mpi

}

void SimCreator::setGlobalIndex(SimInfo *info) {
    SimInfo::MoleculeIterator mi;
    Molecule::AtomIterator ai;
    Molecule::RigidBodyIterator ri;
    Molecule::CutoffGroupIterator ci;
    Molecule * mol;
    Atom * atom;
    RigidBody * rb;
    CutoffGroup * cg;
    int beginAtomIndex;
    int beginRigidBodyIndex;
    int beginCutoffGroupIndex;
    int nGlobalAtoms = info->getNGlobalAtoms();
    
#ifndef IS_MPI

    beginAtomIndex = 0;
    beginRigidBodyIndex = 0;
    beginCutoffGroupIndex = 0;

#else

    int nproc;
    int myNode;

    myNode = worldRank;
    MPI_Comm_size(MPI_COMM_WORLD, &nproc);

    std::vector < int > tmpAtomsInProc(nproc, 0);
    std::vector < int > tmpRigidBodiesInProc(nproc, 0);
    std::vector < int > tmpCutoffGroupsInProc(nproc, 0);
    std::vector < int > NumAtomsInProc(nproc, 0);
    std::vector < int > NumRigidBodiesInProc(nproc, 0);
    std::vector < int > NumCutoffGroupsInProc(nproc, 0);

    tmpAtomsInProc[myNode] = info->getNAtoms();
    tmpRigidBodiesInProc[myNode] = info->getNRigidBodies();
    tmpCutoffGroupsInProc[myNode] = info->getNCutoffGroups();

    //do MPI_ALLREDUCE to exchange the total number of atoms, rigidbodies and cutoff groups
    MPI_Allreduce(&tmpAtomsInProc[0], &NumAtomsInProc[0], nproc, MPI_INT,
                  MPI_SUM, MPI_COMM_WORLD);
    MPI_Allreduce(&tmpRigidBodiesInProc[0], &NumRigidBodiesInProc[0], nproc,
                  MPI_INT, MPI_SUM, MPI_COMM_WORLD);
    MPI_Allreduce(&tmpCutoffGroupsInProc[0], &NumCutoffGroupsInProc[0], nproc,
                  MPI_INT, MPI_SUM, MPI_COMM_WORLD);

    beginAtomIndex = 0;
    beginRigidBodyIndex = 0;
    beginCutoffGroupIndex = 0;

    for(int i = 0; i < myNode; i++) {
        beginAtomIndex += NumAtomsInProc[i];
        beginRigidBodyIndex += NumRigidBodiesInProc[i];
        beginCutoffGroupIndex += NumCutoffGroupsInProc[i];
    }

#endif

    for(mol = info->beginMolecule(mi); mol != NULL;
        mol = info->nextMolecule(mi)) {

        //local index(index in DataStorge) of atom is important
        for(atom = mol->beginAtom(ai); atom != NULL; atom = mol->nextAtom(ai)) {
            atom->setGlobalIndex(beginAtomIndex++);
        }

        for(rb = mol->beginRigidBody(ri); rb != NULL;
            rb = mol->nextRigidBody(ri)) {
            rb->setGlobalIndex(beginRigidBodyIndex++);
        }

        //local index of cutoff group is trivial, it only depends on the order of travesing
        for(cg = mol->beginCutoffGroup(ci); cg != NULL;
            cg = mol->nextCutoffGroup(ci)) {
            cg->setGlobalIndex(beginCutoffGroupIndex++);
        }
    }

    //fill globalGroupMembership
    std::vector<int> globalGroupMembership(info->getNGlobalAtoms(), 0);
    for(mol = info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {        
        for (cg = mol->beginCutoffGroup(ci); cg != NULL; cg = mol->nextCutoffGroup(ci)) {

            for(atom = cg->beginAtom(ai); atom != NULL; atom = cg->nextAtom(ai)) {
                globalGroupMembership[atom->getGlobalIndex()] = cg->getGlobalIndex();
            }

        }       
    }

#ifdef IS_MPI    
    // Since the globalGroupMembership has been zero filled and we've only
    // poked values into the atoms we know, we can do an Allreduce
    // to get the full globalGroupMembership array (We think).
    // This would be prettier if we could use MPI_IN_PLACE like the MPI-2
    // docs said we could.
    std::vector<int> tmpGroupMembership(nGlobalAtoms, 0);
    MPI_Allreduce(&globalGroupMembership[0], &tmpGroupMembership[0], nGlobalAtoms,
                  MPI_INT, MPI_SUM, MPI_COMM_WORLD);
     info->setGlobalGroupMembership(tmpGroupMembership);
#else
    info->setGlobalGroupMembership(globalGroupMembership);
#endif

    //fill molMembership
    std::vector<int> globalMolMembership(info->getNGlobalAtoms(), 0);
    
    for(mol = info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {

        for(atom = mol->beginAtom(ai); atom != NULL; atom = mol->nextAtom(ai)) {
            globalMolMembership[atom->getGlobalIndex()] = mol->getGlobalIndex();
        }
    }

#ifdef IS_MPI
    std::vector<int> tmpMolMembership(nGlobalAtoms, 0);

    MPI_Allreduce(&globalMolMembership[0], &tmpMolMembership[0], nGlobalAtoms,
                  MPI_INT, MPI_SUM, MPI_COMM_WORLD);
    
    info->setGlobalMolMembership(tmpMolMembership);
#else
    info->setGlobalMolMembership(globalMolMembership);
#endif

}

void SimCreator::loadCoordinates(SimInfo* info) {
    Globals* simParams;
    simParams = info->getSimParams();
    
    if (!simParams->haveInitialConfig()) {
        sprintf(painCave.errMsg,
                "Cannot intialize a simulation without an initial configuration file.\n");
        painCave.isFatal = 1;;
        simError();
    }
        
    DumpReader reader(info, simParams->getInitialConfig());
    int nframes = reader.getNFrames();

    if (nframes > 0) {
        reader.readFrame(nframes - 1);
    } else {
        //invalid initial coordinate file
        sprintf(painCave.errMsg, "Initial configuration file %s should at least contain one frame\n",
                simParams->getInitialConfig());
        painCave.isFatal = 1;
        simError();
    }

    //copy the current snapshot to previous snapshot
    info->getSnapshotManager()->advance();
}

} //end namespace oopse


Revision:	1930
Committed:	Wed Jan 12 22:41:40 2005 UTC (19 years, 5 months ago) by gezelter
File size:	20659 byte(s)
Log Message:	merging new_design branch into OOPSE-2.0
#	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 <sprng.h>
51
52	#include "brains/MoleculeCreator.hpp"
53	#include "brains/SimCreator.hpp"
54	#include "brains/SimSnapshotManager.hpp"
55	#include "io/DumpReader.hpp"
56	#include "io/parse_me.h"
57	#include "UseTheForce/ForceFieldFactory.hpp"
58	#include "utils/simError.h"
59	#include "utils/StringUtils.hpp"
60	#ifdef IS_MPI
61	#include "io/mpiBASS.h"
62	#include "math/randomSPRNG.hpp"
63	#endif
64
65	namespace oopse {
66
67	void SimCreator::parseFile(const std::string mdFileName, MakeStamps* stamps, 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	std::string forcefieldFileName;
120	forcefieldFileName = ff->getForceFieldFileName();
121
122	if (simParams->haveForceFieldVariant()) {
123	//If the force field has variant, the variant force field name will be
124	//Base.variant.frc. For exampel EAM.u6.frc
125
126	std::string variant = simParams->getForceFieldVariant();
127
128	std::string::size_type pos = forcefieldFileName.rfind(".frc");
129	variant = "." + variant;
130	if (pos != std::string::npos) {
131	forcefieldFileName.insert(pos, variant);
132	} else {
133	//If the default force field file name does not containt .frc suffix, just append the .variant
134	forcefieldFileName.append(variant);
135	}
136	}
137
138	ff->parse(forcefieldFileName);
139
140	//extract the molecule stamps
141	std::vector < std::pair<MoleculeStamp *, int> > moleculeStampPairs;
142	compList(stamps, simParams, moleculeStampPairs);
143
144	//create SimInfo
145	SimInfo * info = new SimInfo(moleculeStampPairs, ff, simParams);
146
147	//gather parameters (SimCreator only retrieves part of the parameters)
148	gatherParameters(info, mdFileName);
149
150	//divide the molecules and determine the global index of molecules
151	#ifdef IS_MPI
152	divideMolecules(info);
153	#endif
154
155	//create the molecules
156	createMolecules(info);
157
158
159	//allocate memory for DataStorage(circular reference, need to break it)
160	info->setSnapshotManager(new SimSnapshotManager(info));
161
162	//set the global index of atoms, rigidbodies and cutoffgroups (only need to be set once, the
163	//global index will never change again). Local indices of atoms and rigidbodies are already set by
164	//MoleculeCreator class which actually delegates the responsibility to LocalIndexManager.
165	setGlobalIndex(info);
166
167	//Alought addExculdePairs is called inside SimInfo's addMolecule method, at that point
168	//atoms don't have the global index yet (their global index are all initialized to -1).
169	//Therefore we have to call addExcludePairs explicitly here. A way to work around is that
170	//we can determine the beginning global indices of atoms before they get created.
171	SimInfo::MoleculeIterator mi;
172	Molecule* mol;
173	for (mol= info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
174	info->addExcludePairs(mol);
175	}
176
177
178	//load initial coordinates, some extra information are pushed into SimInfo's property map ( such as
179	//eta, chi for NPT integrator)
180	if (loadInitCoords)
181	loadCoordinates(info);
182
183	return info;
184	}
185
186	void SimCreator::gatherParameters(SimInfo *info, const std::string& mdfile) {
187
188	//setup seed for random number generator
189	int seedValue;
190	Globals * simParams = info->getSimParams();
191
192	if (simParams->haveSeed()) {
193	seedValue = simParams->getSeed();
194
195	if (seedValue < 100000000 ) {
196	sprintf(painCave.errMsg,
197	"Seed for sprng library should contain at least 9 digits\n"
198	"OOPSE will generate a seed for user\n");
199
200	painCave.isFatal = 0;
201	simError();
202
203	//using seed generated by system instead of invalid seed set by user
204
205	#ifndef IS_MPI
206
207	seedValue = make_sprng_seed();
208
209	#else
210
211	if (worldRank == 0) {
212	seedValue = make_sprng_seed();
213	}
214
215	MPI_Bcast(&seedValue, 1, MPI_INT, 0, MPI_COMM_WORLD);
216
217	#endif
218
219	} //end if (seedValue /1000000000 == 0)
220	} else {
221
222	#ifndef IS_MPI
223
224	seedValue = make_sprng_seed();
225
226	#else
227
228	if (worldRank == 0) {
229	seedValue = make_sprng_seed();
230	}
231
232	MPI_Bcast(&seedValue, 1, MPI_INT, 0, MPI_COMM_WORLD);
233
234	#endif
235
236	} //end of simParams->haveSeed()
237
238	info->setSeed(seedValue);
239
240
241	//figure out the ouput file names
242	std::string prefix;
243
244	#ifdef IS_MPI
245
246	if (worldRank == 0) {
247	#endif // is_mpi
248
249	if (simParams->haveFinalConfig()) {
250	prefix = getPrefix(simParams->getFinalConfig());
251	} else {
252	prefix = getPrefix(mdfile);
253	}
254
255	info->setFinalConfigFileName(prefix + ".eor");
256	info->setDumpFileName(prefix + ".dump");
257	info->setStatFileName(prefix + ".stat");
258
259	#ifdef IS_MPI
260
261	}
262
263	#endif
264
265	}
266
267	#ifdef IS_MPI
268	void SimCreator::divideMolecules(SimInfo *info) {
269	double numerator;
270	double denominator;
271	double precast;
272	double x;
273	double y;
274	double a;
275	int old_atoms;
276	int add_atoms;
277	int new_atoms;
278	int nTarget;
279	int done;
280	int i;
281	int j;
282	int loops;
283	int which_proc;
284	int nProcessors;
285	std::vector<int> atomsPerProc;
286	randomSPRNG myRandom(info->getSeed());
287	int nGlobalMols = info->getNGlobalMolecules();
288	std::vector<int> molToProcMap(nGlobalMols, -1); // default to an error condition:
289
290	MPI_Comm_size(MPI_COMM_WORLD, &nProcessors);
291
292	if (nProcessors > nGlobalMols) {
293	sprintf(painCave.errMsg,
294	"nProcessors (%d) > nMol (%d)\n"
295	"\tThe number of processors is larger than\n"
296	"\tthe number of molecules. This will not result in a \n"
297	"\tusable division of atoms for force decomposition.\n"
298	"\tEither try a smaller number of processors, or run the\n"
299	"\tsingle-processor version of OOPSE.\n", nProcessors, nGlobalMols);
300
301	painCave.isFatal = 1;
302	simError();
303	}
304
305	a = 3.0 * nGlobalMols / info->getNGlobalAtoms();
306
307	//initialize atomsPerProc
308	atomsPerProc.insert(atomsPerProc.end(), nProcessors, 0);
309
310	if (worldRank == 0) {
311	numerator = info->getNGlobalAtoms();
312	denominator = nProcessors;
313	precast = numerator / denominator;
314	nTarget = (int)(precast + 0.5);
315
316	for(i = 0; i < nGlobalMols; i++) {
317	done = 0;
318	loops = 0;
319
320	while (!done) {
321	loops++;
322
323	// Pick a processor at random
324
325	which_proc = (int) (myRandom.getRandom() * nProcessors);
326
327	//get the molecule stamp first
328	int stampId = info->getMoleculeStampId(i);
329	MoleculeStamp * moleculeStamp = info->getMoleculeStamp(stampId);
330
331	// How many atoms does this processor have so far?
332	old_atoms = atomsPerProc[which_proc];
333	add_atoms = moleculeStamp->getNAtoms();
334	new_atoms = old_atoms + add_atoms;
335
336	// If we've been through this loop too many times, we need
337	// to just give up and assign the molecule to this processor
338	// and be done with it.
339
340	if (loops > 100) {
341	sprintf(painCave.errMsg,
342	"I've tried 100 times to assign molecule %d to a "
343	" processor, but can't find a good spot.\n"
344	"I'm assigning it at random to processor %d.\n",
345	i, which_proc);
346
347	painCave.isFatal = 0;
348	simError();
349
350	molToProcMap[i] = which_proc;
351	atomsPerProc[which_proc] += add_atoms;
352
353	done = 1;
354	continue;
355	}
356
357	// If we can add this molecule to this processor without sending
358	// it above nTarget, then go ahead and do it:
359
360	if (new_atoms <= nTarget) {
361	molToProcMap[i] = which_proc;
362	atomsPerProc[which_proc] += add_atoms;
363
364	done = 1;
365	continue;
366	}
367
368	// The only situation left is when new_atoms > nTarget. We
369	// want to accept this with some probability that dies off the
370	// farther we are from nTarget
371
372	// roughly: x = new_atoms - nTarget
373	// Pacc(x) = exp(- a * x)
374	// where a = penalty / (average atoms per molecule)
375
376	x = (double)(new_atoms - nTarget);
377	y = myRandom.getRandom();
378
379	if (y < exp(- a * x)) {
380	molToProcMap[i] = which_proc;
381	atomsPerProc[which_proc] += add_atoms;
382
383	done = 1;
384	continue;
385	} else {
386	continue;
387	}
388	}
389	}
390
391	// Spray out this nonsense to all other processors:
392
393	MPI_Bcast(&molToProcMap[0], nGlobalMols, MPI_INT, 0, MPI_COMM_WORLD);
394	} else {
395
396	// Listen to your marching orders from processor 0:
397
398	MPI_Bcast(&molToProcMap[0], nGlobalMols, MPI_INT, 0, MPI_COMM_WORLD);
399	}
400
401	info->setMolToProcMap(molToProcMap);
402	sprintf(checkPointMsg,
403	"Successfully divided the molecules among the processors.\n");
404	MPIcheckPoint();
405	}
406
407	#endif
408
409	void SimCreator::createMolecules(SimInfo *info) {
410	MoleculeCreator molCreator;
411	int stampId;
412
413	for(int i = 0; i < info->getNGlobalMolecules(); i++) {
414
415	#ifdef IS_MPI
416
417	if (info->getMolToProc(i) == worldRank) {
418	#endif
419
420	stampId = info->getMoleculeStampId(i);
421	Molecule * mol = molCreator.createMolecule(info->getForceField(), info->getMoleculeStamp(stampId),
422	stampId, i, info->getLocalIndexManager());
423
424	info->addMolecule(mol);
425
426	#ifdef IS_MPI
427
428	}
429
430	#endif
431
432	} //end for(int i=0)
433	}
434
435	void SimCreator::compList(MakeStamps stamps, Globals simParams,
436	std::vector < std::pair<MoleculeStamp *, int> > &moleculeStampPairs) {
437	int i;
438	char * id;
439	MoleculeStamp * currentStamp;
440	Component** the_components = simParams->getComponents();
441	int n_components = simParams->getNComponents();
442
443	if (!simParams->haveNMol()) {
444	// we don't have the total number of molecules, so we assume it is
445	// given in each component
446
447	for(i = 0; i < n_components; i++) {
448	if (!the_components[i]->haveNMol()) {
449	// we have a problem
450	sprintf(painCave.errMsg,
451	"SimCreator Error. No global NMol or component NMol given.\n"
452	"\tCannot calculate the number of atoms.\n");
453
454	painCave.isFatal = 1;
455	simError();
456	}
457
458	id = the_components[i]->getType();
459	currentStamp = (stamps->extractMolStamp(id))->getStamp();
460
461	if (currentStamp == NULL) {
462	sprintf(painCave.errMsg,
463	"SimCreator error: Component \"%s\" was not found in the "
464	"list of declared molecules\n", id);
465
466	painCave.isFatal = 1;
467	simError();
468	}
469
470	moleculeStampPairs.push_back(
471	std::make_pair(currentStamp, the_components[i]->getNMol()));
472	} //end for (i = 0; i < n_components; i++)
473	} else {
474	sprintf(painCave.errMsg, "SimSetup error.\n"
475	"\tSorry, the ability to specify total"
476	" nMols and then give molfractions in the components\n"
477	"\tis not currently supported."
478	" Please give nMol in the components.\n");
479
480	painCave.isFatal = 1;
481	simError();
482	}
483
484	#ifdef IS_MPI
485
486	strcpy(checkPointMsg, "Component stamps successfully extracted\n");
487	MPIcheckPoint();
488
489	#endif // is_mpi
490
491	}
492
493	void SimCreator::setGlobalIndex(SimInfo *info) {
494	SimInfo::MoleculeIterator mi;
495	Molecule::AtomIterator ai;
496	Molecule::RigidBodyIterator ri;
497	Molecule::CutoffGroupIterator ci;
498	Molecule * mol;
499	Atom * atom;
500	RigidBody * rb;
501	CutoffGroup * cg;
502	int beginAtomIndex;
503	int beginRigidBodyIndex;
504	int beginCutoffGroupIndex;
505	int nGlobalAtoms = info->getNGlobalAtoms();
506
507	#ifndef IS_MPI
508
509	beginAtomIndex = 0;
510	beginRigidBodyIndex = 0;
511	beginCutoffGroupIndex = 0;
512
513	#else
514
515	int nproc;
516	int myNode;
517
518	myNode = worldRank;
519	MPI_Comm_size(MPI_COMM_WORLD, &nproc);
520
521	std::vector < int > tmpAtomsInProc(nproc, 0);
522	std::vector < int > tmpRigidBodiesInProc(nproc, 0);
523	std::vector < int > tmpCutoffGroupsInProc(nproc, 0);
524	std::vector < int > NumAtomsInProc(nproc, 0);
525	std::vector < int > NumRigidBodiesInProc(nproc, 0);
526	std::vector < int > NumCutoffGroupsInProc(nproc, 0);
527
528	tmpAtomsInProc[myNode] = info->getNAtoms();
529	tmpRigidBodiesInProc[myNode] = info->getNRigidBodies();
530	tmpCutoffGroupsInProc[myNode] = info->getNCutoffGroups();
531
532	//do MPI_ALLREDUCE to exchange the total number of atoms, rigidbodies and cutoff groups
533	MPI_Allreduce(&tmpAtomsInProc[0], &NumAtomsInProc[0], nproc, MPI_INT,
534	MPI_SUM, MPI_COMM_WORLD);
535	MPI_Allreduce(&tmpRigidBodiesInProc[0], &NumRigidBodiesInProc[0], nproc,
536	MPI_INT, MPI_SUM, MPI_COMM_WORLD);
537	MPI_Allreduce(&tmpCutoffGroupsInProc[0], &NumCutoffGroupsInProc[0], nproc,
538	MPI_INT, MPI_SUM, MPI_COMM_WORLD);
539
540	beginAtomIndex = 0;
541	beginRigidBodyIndex = 0;
542	beginCutoffGroupIndex = 0;
543
544	for(int i = 0; i < myNode; i++) {
545	beginAtomIndex += NumAtomsInProc[i];
546	beginRigidBodyIndex += NumRigidBodiesInProc[i];
547	beginCutoffGroupIndex += NumCutoffGroupsInProc[i];
548	}
549
550	#endif
551
552	for(mol = info->beginMolecule(mi); mol != NULL;
553	mol = info->nextMolecule(mi)) {
554
555	//local index(index in DataStorge) of atom is important
556	for(atom = mol->beginAtom(ai); atom != NULL; atom = mol->nextAtom(ai)) {
557	atom->setGlobalIndex(beginAtomIndex++);
558	}
559
560	for(rb = mol->beginRigidBody(ri); rb != NULL;
561	rb = mol->nextRigidBody(ri)) {
562	rb->setGlobalIndex(beginRigidBodyIndex++);
563	}
564
565	//local index of cutoff group is trivial, it only depends on the order of travesing
566	for(cg = mol->beginCutoffGroup(ci); cg != NULL;
567	cg = mol->nextCutoffGroup(ci)) {
568	cg->setGlobalIndex(beginCutoffGroupIndex++);
569	}
570	}
571
572	//fill globalGroupMembership
573	std::vector<int> globalGroupMembership(info->getNGlobalAtoms(), 0);
574	for(mol = info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
575	for (cg = mol->beginCutoffGroup(ci); cg != NULL; cg = mol->nextCutoffGroup(ci)) {
576
577	for(atom = cg->beginAtom(ai); atom != NULL; atom = cg->nextAtom(ai)) {
578	globalGroupMembership[atom->getGlobalIndex()] = cg->getGlobalIndex();
579	}
580
581	}
582	}
583
584	#ifdef IS_MPI
585	// Since the globalGroupMembership has been zero filled and we've only
586	// poked values into the atoms we know, we can do an Allreduce
587	// to get the full globalGroupMembership array (We think).
588	// This would be prettier if we could use MPI_IN_PLACE like the MPI-2
589	// docs said we could.
590	std::vector<int> tmpGroupMembership(nGlobalAtoms, 0);
591	MPI_Allreduce(&globalGroupMembership[0], &tmpGroupMembership[0], nGlobalAtoms,
592	MPI_INT, MPI_SUM, MPI_COMM_WORLD);
593	info->setGlobalGroupMembership(tmpGroupMembership);
594	#else
595	info->setGlobalGroupMembership(globalGroupMembership);
596	#endif
597
598	//fill molMembership
599	std::vector<int> globalMolMembership(info->getNGlobalAtoms(), 0);
600
601	for(mol = info->beginMolecule(mi); mol != NULL; mol = info->nextMolecule(mi)) {
602
603	for(atom = mol->beginAtom(ai); atom != NULL; atom = mol->nextAtom(ai)) {
604	globalMolMembership[atom->getGlobalIndex()] = mol->getGlobalIndex();
605	}
606	}
607
608	#ifdef IS_MPI
609	std::vector<int> tmpMolMembership(nGlobalAtoms, 0);
610
611	MPI_Allreduce(&globalMolMembership[0], &tmpMolMembership[0], nGlobalAtoms,
612	MPI_INT, MPI_SUM, MPI_COMM_WORLD);
613
614	info->setGlobalMolMembership(tmpMolMembership);
615	#else
616	info->setGlobalMolMembership(globalMolMembership);
617	#endif
618
619	}
620
621	void SimCreator::loadCoordinates(SimInfo* info) {
622	Globals* simParams;
623	simParams = info->getSimParams();
624
625	if (!simParams->haveInitialConfig()) {
626	sprintf(painCave.errMsg,
627	"Cannot intialize a simulation without an initial configuration file.\n");
628	painCave.isFatal = 1;;
629	simError();
630	}
631
632	DumpReader reader(info, simParams->getInitialConfig());
633	int nframes = reader.getNFrames();
634
635	if (nframes > 0) {
636	reader.readFrame(nframes - 1);
637	} else {
638	//invalid initial coordinate file
639	sprintf(painCave.errMsg, "Initial configuration file %s should at least contain one frame\n",
640	simParams->getInitialConfig());
641	painCave.isFatal = 1;
642	simError();
643	}
644
645	//copy the current snapshot to previous snapshot
646	info->getSnapshotManager()->advance();
647	}
648
649	} //end namespace oopse
650
651