| 1 |
/* |
| 2 |
* Copyright (C) 2000-2004 Object Oriented Parallel Simulation Engine (OOPSE) project |
| 3 |
* |
| 4 |
* Contact: oopse@oopse.org |
| 5 |
* |
| 6 |
* This program is free software; you can redistribute it and/or |
| 7 |
* modify it under the terms of the GNU Lesser General Public License |
| 8 |
* as published by the Free Software Foundation; either version 2.1 |
| 9 |
* of the License, or (at your option) any later version. |
| 10 |
* All we ask is that proper credit is given for our work, which includes |
| 11 |
* - but is not limited to - adding the above copyright notice to the beginning |
| 12 |
* of your source code files, and to any copyright notice that you may distribute |
| 13 |
* with programs based on this work. |
| 14 |
* |
| 15 |
* This program is distributed in the hope that it will be useful, |
| 16 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 |
* GNU Lesser General Public License for more details. |
| 19 |
* |
| 20 |
* You should have received a copy of the GNU Lesser General Public License |
| 21 |
* along with this program; if not, write to the Free Software |
| 22 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 23 |
* |
| 24 |
*/ |
| 25 |
|
| 26 |
/** |
| 27 |
* @file SimCreatorr.hpp |
| 28 |
* @author tlin |
| 29 |
* @date 11/02/2004 |
| 30 |
* @time 12:126am |
| 31 |
* @version 1.0 |
| 32 |
*/ |
| 33 |
|
| 34 |
#ifndef BRAINS_SIMCREATOR_HPP |
| 35 |
#define BRAINS_SIMCREATOR_HPP |
| 36 |
|
| 37 |
|
| 38 |
#include "primitives/Molecule.hpp" |
| 39 |
#include "brains/SimInfo.hpp" |
| 40 |
#include "types/MakeStamps.hpp" |
| 41 |
#include "io/Globals.hpp" |
| 42 |
#include "UseTheForce/ForceField.hpp" |
| 43 |
|
| 44 |
// this routine is defined in BASS_interface.cpp |
| 45 |
//another OOPS |
| 46 |
extern void set_interface_stamps( MakeStamps* ms, Globals* g ); |
| 47 |
|
| 48 |
namespace oopse { |
| 49 |
|
| 50 |
/** |
| 51 |
* @class SimCreator SimCreator.hpp "brains/SimCreator.hpp" |
| 52 |
* The only responsibility of SimCreator is to parse the meta-data file and create a SimInfo |
| 53 |
* instance based on the information returned by parser. |
| 54 |
*/ |
| 55 |
class SimCreator { |
| 56 |
public: |
| 57 |
|
| 58 |
/** |
| 59 |
* Setup Simulation |
| 60 |
* @return a pointer to SimInfo |
| 61 |
* @param mdfile the meta-data file name |
| 62 |
*/ |
| 63 |
SimInfo* createSim(const std::string & mdFileName); |
| 64 |
|
| 65 |
private: |
| 66 |
|
| 67 |
/** |
| 68 |
* Parses the meta-data file |
| 69 |
* @param mdfile |
| 70 |
* @param stamps |
| 71 |
* @param simParams |
| 72 |
*/ |
| 73 |
void parseFile(const std::string mdFileName, MakeStamps* stamps, Globals* simParams); |
| 74 |
|
| 75 |
|
| 76 |
/** create the molecules belong to current processor*/ |
| 77 |
virtual void createMolecules(SimInfo* info); |
| 78 |
|
| 79 |
/** |
| 80 |
* Sets the global index for atoms, rigidbodies and cutoff groups and fill up |
| 81 |
* globalGroupMembership and globalMolMembership arrays which map atoms' |
| 82 |
* global index to the global index of the groups (or molecules) they belong to. |
| 83 |
* These array are never changed during the simulation. |
| 84 |
*/ |
| 85 |
void setGlobalIndex(SimInfo* info); |
| 86 |
|
| 87 |
void gatherParameters(SimInfo *info, const std::string& mdfile); |
| 88 |
|
| 89 |
|
| 90 |
/** Extracts the molecules stamps and adds them into SimInfo class */ |
| 91 |
void compList(MakeStamps* stamps, Globals* simParams, |
| 92 |
std::vector<std::pair<MoleculeStamp*, int> >& moleculeStamps) ; |
| 93 |
|
| 94 |
/** |
| 95 |
* Divide the molecules among the processors |
| 96 |
*/ |
| 97 |
|
| 98 |
void divideMolecules(SimInfo* info); |
| 99 |
|
| 100 |
/** Load initial coordinates */ |
| 101 |
void loadCoordinates(SimInfo* info); |
| 102 |
|
| 103 |
std::string mdFileName_; //save the meta-data file name which may be used later |
| 104 |
}; |
| 105 |
|
| 106 |
} //end namespace oopse |
| 107 |
#endif //BRAINS_SIMCREATOR_HPP |
| 108 |
|
