src/brains/MoleculeCreator.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. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
  
/**
 * @file MoleculeCreator.cpp
 * @author tlin
 * @date 11/04/2004
 * @time 13:44am
 * @version 1.0
 */

#include <cassert>
#include <typeinfo>
#include <set>

#include "brains/MoleculeCreator.hpp"
#include "primitives/GhostBend.hpp"
#include "primitives/GhostTorsion.hpp"
#include "types/AtomType.hpp"
#include "types/FixedBondType.hpp"
#include "utils/simError.h"
#include "utils/StringUtils.hpp"

namespace OpenMD {
  
  Molecule* MoleculeCreator::createMolecule(ForceField* ff, 
                                            MoleculeStamp *molStamp,
                                            int stampId, int globalIndex, 
                                            LocalIndexManager* localIndexMan) {
    Molecule* mol = new Molecule(stampId, globalIndex, molStamp->getName());
    
    //create atoms
    Atom* atom;
    AtomStamp* currentAtomStamp;
    int nAtom = molStamp->getNAtoms();
    for (int i = 0; i < nAtom; ++i) {
      currentAtomStamp = molStamp->getAtomStamp(i);
      atom = createAtom(ff, mol, currentAtomStamp, localIndexMan);
      mol->addAtom(atom);
    }

    //create rigidbodies
    RigidBody* rb;
    RigidBodyStamp * currentRigidBodyStamp;
    int nRigidbodies = molStamp->getNRigidBodies();

    for (int i = 0; i < nRigidbodies; ++i) {
      currentRigidBodyStamp = molStamp->getRigidBodyStamp(i);
      rb = createRigidBody(molStamp, mol, currentRigidBodyStamp, 
                           localIndexMan);
      mol->addRigidBody(rb);
    }
    
    //create bonds
    Bond* bond;
    BondStamp* currentBondStamp;
    int nBonds = molStamp->getNBonds();

    for (int i = 0; i < nBonds; ++i) {
      currentBondStamp = molStamp->getBondStamp(i);
      bond = createBond(ff, mol, currentBondStamp);
      mol->addBond(bond);
    }

    //create bends
    Bend* bend;
    BendStamp* currentBendStamp;
    int nBends = molStamp->getNBends();
    for (int i = 0; i < nBends; ++i) {
      currentBendStamp = molStamp->getBendStamp(i);
      bend = createBend(ff, mol, currentBendStamp);
      mol->addBend(bend);
    }

    //create torsions
    Torsion* torsion;
    TorsionStamp* currentTorsionStamp;
    int nTorsions = molStamp->getNTorsions();
    for (int i = 0; i < nTorsions; ++i) {
      currentTorsionStamp = molStamp->getTorsionStamp(i);
      torsion = createTorsion(ff, mol, currentTorsionStamp);
      mol->addTorsion(torsion);
    }

    //create inversions
    Inversion* inversion;
    InversionStamp* currentInversionStamp;
    int nInversions = molStamp->getNInversions();
    for (int i = 0; i < nInversions; ++i) {
      currentInversionStamp = molStamp->getInversionStamp(i);
      inversion = createInversion(ff, mol, currentInversionStamp);
      if (inversion != NULL ) {
        mol->addInversion(inversion);
      }
    }

    //create cutoffGroups
    CutoffGroup* cutoffGroup;
    CutoffGroupStamp* currentCutoffGroupStamp;
    int nCutoffGroups = molStamp->getNCutoffGroups();
    for (int i = 0; i < nCutoffGroups; ++i) {
      currentCutoffGroupStamp = molStamp->getCutoffGroupStamp(i);
      cutoffGroup = createCutoffGroup(mol, currentCutoffGroupStamp, localIndexMan);
      mol->addCutoffGroup(cutoffGroup);
    }

    //every free atom is a cutoff group    
    std::vector<Atom*> freeAtoms;
    std::vector<Atom*>::iterator ai;
    std::vector<Atom*>::iterator fai;

    //add all atoms into allAtoms set
    for(atom = mol->beginAtom(fai); atom != NULL; atom = mol->nextAtom(fai)) {
      freeAtoms.push_back(atom);
    }

    Molecule::CutoffGroupIterator ci;
    CutoffGroup* cg;
    
    for (cg = mol->beginCutoffGroup(ci); cg != NULL; 
         cg = mol->nextCutoffGroup(ci)) {
      
      for(atom = cg->beginAtom(ai); atom != NULL; atom = cg->nextAtom(ai)) {
        //erase the atoms belong to cutoff groups from freeAtoms vector
        freeAtoms.erase(std::remove(freeAtoms.begin(), freeAtoms.end(), atom),
                        freeAtoms.end());
      }      
    }       
    
    // loop over the free atoms and then create one cutoff group for
    // every single free atom
    
    for (fai = freeAtoms.begin(); fai != freeAtoms.end(); ++fai) {
      cutoffGroup = createCutoffGroup(mol, *fai, localIndexMan);
      mol->addCutoffGroup(cutoffGroup);
    }
    //create constraints
    createConstraintPair(mol);
    createConstraintElem(mol);
    
    //the construction of this molecule is finished
    mol->complete();
    
    return mol;
  }    


  Atom* MoleculeCreator::createAtom(ForceField* ff, Molecule* mol, 
                                    AtomStamp* stamp,
                                    LocalIndexManager* localIndexMan) {
    AtomType * atomType;
    Atom* atom;

    atomType =  ff->getAtomType(stamp->getType());
    
    if (atomType == NULL) {
      sprintf(painCave.errMsg, "Can not find Matching Atom Type for[%s]",
              stamp->getType().c_str());

      painCave.isFatal = 1;
      simError();
    }
    
    //below code still have some kind of hard-coding smell
    if (atomType->isDirectional()){
      DirectionalAtom* dAtom;
      dAtom = new DirectionalAtom(atomType);
      atom = dAtom;    
    }
    else{
      atom = new Atom(atomType);
    }

    atom->setLocalIndex(localIndexMan->getNextAtomIndex());

    return atom;
  }
  
  RigidBody* MoleculeCreator::createRigidBody(MoleculeStamp *molStamp, 
                                              Molecule* mol,
                                              RigidBodyStamp* rbStamp, 
                                              LocalIndexManager* localIndexMan) {
    Atom* atom;
    int nAtoms;
    Vector3d refCoor;
    AtomStamp* atomStamp;
    
    RigidBody* rb = new RigidBody();
    nAtoms = rbStamp->getNMembers();    
    for (int i = 0; i < nAtoms; ++i) {
      //rbStamp->getMember(i) return the local index of current atom
      //inside the molecule.  It is not the same as local index of
      //atom which is the index of atom at DataStorage class
      atom = mol->getAtomAt(rbStamp->getMemberAt(i));
      atomStamp= molStamp->getAtomStamp(rbStamp->getMemberAt(i));    
      rb->addAtom(atom, atomStamp);
    }

    //after all of the atoms are added, we need to calculate the
    //reference coordinates
    rb->calcRefCoords();

    //set the local index of this rigid body, global index will be set later
    rb->setLocalIndex(localIndexMan->getNextRigidBodyIndex());

    //the rule for naming rigidbody MoleculeName_RB_Integer
    //The first part is the name of the molecule
    //The second part is alway fixed as "RB"
    //The third part is the index of the rigidbody defined in meta-data file
    //For example, Butane_RB_0 is a valid rigid body name of butane molecule
    /**@todo replace itoa by lexi_cast */
    std::string s = OpenMD_itoa(mol->getNRigidBodies(), 10);
    rb->setType(mol->getType() + "_RB_" + s.c_str());

    return rb;
  }    

  Bond* MoleculeCreator::createBond(ForceField* ff, Molecule* mol, 
                                    BondStamp* stamp) {
    BondType* bondType;
    Atom* atomA;
    Atom* atomB;
    
    atomA = mol->getAtomAt(stamp->getA());
    atomB = mol->getAtomAt(stamp->getB());
    
    assert( atomA && atomB);
    
    bondType = ff->getBondType(atomA->getType(), atomB->getType());

    if (bondType == NULL) {
      sprintf(painCave.errMsg, "Can not find Matching Bond Type for[%s, %s]",
              atomA->getType().c_str(),
              atomB->getType().c_str());
      
      painCave.isFatal = 1;
      simError();
    }
    return new Bond(atomA, atomB, bondType);    
  }    
  
  Bend* MoleculeCreator::createBend(ForceField* ff, Molecule* mol, 
                                    BendStamp* stamp) {
    Bend* bend = NULL; 
    std::vector<int> bendAtoms = stamp->getMembers(); 
    if (bendAtoms.size() == 3) {
      Atom* atomA = mol->getAtomAt(bendAtoms[0]);
      Atom* atomB = mol->getAtomAt(bendAtoms[1]);
      Atom* atomC = mol->getAtomAt(bendAtoms[2]);
      
      assert( atomA && atomB && atomC);
      
      BendType* bendType = ff->getBendType(atomA->getType().c_str(), 
                                           atomB->getType().c_str(), 
                                           atomC->getType().c_str());
      
      if (bendType == NULL) {
        sprintf(painCave.errMsg, "Can not find Matching Bend Type for[%s, %s, %s]",
                atomA->getType().c_str(),
                atomB->getType().c_str(),
                atomC->getType().c_str());
        
        painCave.isFatal = 1;
        simError();
      }
      
      bend = new Bend(atomA, atomB, atomC, bendType);
    } else if ( bendAtoms.size() == 2 && stamp->haveGhostVectorSource()) {
      int ghostIndex = stamp->getGhostVectorSource();
      int normalIndex = ghostIndex != bendAtoms[0] ? bendAtoms[0] : bendAtoms[1]; 
      Atom* normalAtom = mol->getAtomAt(normalIndex) ;        
      DirectionalAtom* ghostAtom = dynamic_cast<DirectionalAtom*>(mol->getAtomAt(ghostIndex));
      if (ghostAtom == NULL) {
        sprintf(painCave.errMsg, "Can not cast Atom to DirectionalAtom");
        painCave.isFatal = 1;
        simError();
      }
                
      BendType* bendType = ff->getBendType(normalAtom->getType(), ghostAtom->getType(), "GHOST");

      if (bendType == NULL) {
        sprintf(painCave.errMsg, "Can not find Matching Bend Type for[%s, %s, %s]",
                normalAtom->getType().c_str(),
                ghostAtom->getType().c_str(),
                "GHOST");

        painCave.isFatal = 1;
        simError();
      }
      
      bend = new GhostBend(normalAtom, ghostAtom, bendType);       
      
    } 
    
    return bend;
  }    

  Torsion* MoleculeCreator::createTorsion(ForceField* ff, Molecule* mol, 
                                          TorsionStamp* stamp) {

    Torsion* torsion = NULL;
    std::vector<int> torsionAtoms = stamp->getMembers();
    if (torsionAtoms.size() < 3) {
        return torsion;
    }

    Atom* atomA = mol->getAtomAt(torsionAtoms[0]);
    Atom* atomB = mol->getAtomAt(torsionAtoms[1]);
    Atom* atomC = mol->getAtomAt(torsionAtoms[2]);

    if (torsionAtoms.size() == 4) {
      Atom* atomD = mol->getAtomAt(torsionAtoms[3]);

      assert(atomA && atomB && atomC && atomD);
        
      TorsionType* torsionType = ff->getTorsionType(atomA->getType(), 
                                                    atomB->getType(), 
                                                    atomC->getType(), 
                                                    atomD->getType());
      if (torsionType == NULL) {
        sprintf(painCave.errMsg, "Can not find Matching Torsion Type for[%s, %s, %s, %s]",
                atomA->getType().c_str(),
                atomB->getType().c_str(),
                atomC->getType().c_str(),
                atomD->getType().c_str());
        
        painCave.isFatal = 1;
        simError();
      }
      
      torsion = new Torsion(atomA, atomB, atomC, atomD, torsionType);       
    }
    else {
      
      DirectionalAtom* dAtom = dynamic_cast<DirectionalAtom*>(mol->getAtomAt(stamp->getGhostVectorSource()));
      if (dAtom == NULL) {
        sprintf(painCave.errMsg, "Can not cast Atom to DirectionalAtom");
        painCave.isFatal = 1;
        simError();
      }        
      
      TorsionType* torsionType = ff->getTorsionType(atomA->getType(), atomB->getType(), 
                                                    atomC->getType(), "GHOST");
      
      if (torsionType == NULL) {
        sprintf(painCave.errMsg, "Can not find Matching Torsion Type for[%s, %s, %s, %s]",
                atomA->getType().c_str(),
                atomB->getType().c_str(),
                atomC->getType().c_str(),
                "GHOST");
        
        painCave.isFatal = 1;
        simError();
      }
      
      torsion = new GhostTorsion(atomA, atomB, dAtom, torsionType);               
    }
    
    return torsion;
  }    

  Inversion* MoleculeCreator::createInversion(ForceField* ff, Molecule* mol, 
                                              InversionStamp* stamp) {
    
    Inversion* inversion = NULL;
    int center = stamp->getCenter();
    std::vector<int> satellites = stamp->getSatellites();
    if (satellites.size() != 3) {
        return inversion;
    }

    Atom* atomA = mol->getAtomAt(center);
    Atom* atomB = mol->getAtomAt(satellites[0]);
    Atom* atomC = mol->getAtomAt(satellites[1]);
    Atom* atomD = mol->getAtomAt(satellites[2]);
      
    assert(atomA && atomB && atomC && atomD);
    
    InversionType* inversionType = ff->getInversionType(atomA->getType(), 
                                                        atomB->getType(), 
                                                        atomC->getType(), 
                                                        atomD->getType());

    if (inversionType == NULL) {
      sprintf(painCave.errMsg, "No Matching Inversion Type for[%s, %s, %s, %s]\n"
              "\t(May not be a problem: not all inversions are parametrized)\n",
              atomA->getType().c_str(),
              atomB->getType().c_str(),
              atomC->getType().c_str(),
              atomD->getType().c_str());
      
      painCave.isFatal = 0;
      painCave.severity = OPENMD_INFO;
      simError();
      return NULL;
    } else {
      
      inversion = new Inversion(atomA, atomB, atomC, atomD, inversionType);
      return inversion;
    }
  }
  

  CutoffGroup* MoleculeCreator::createCutoffGroup(Molecule* mol, 
                                                  CutoffGroupStamp* stamp,
                                                  LocalIndexManager* localIndexMan) {
    int nAtoms;
    CutoffGroup* cg;
    Atom* atom;
    cg = new CutoffGroup();
    
    nAtoms = stamp->getNMembers();
    for (int i =0; i < nAtoms; ++i) {
      atom = mol->getAtomAt(stamp->getMemberAt(i));
      assert(atom);
      cg->addAtom(atom);
    }
    
    //set the local index of this cutoffGroup, global index will be set later
    cg->setLocalIndex(localIndexMan->getNextCutoffGroupIndex());
    
    return cg;
  }    
  
  CutoffGroup* MoleculeCreator::createCutoffGroup(Molecule * mol, Atom* atom,
                                                  LocalIndexManager* localIndexMan) {
    CutoffGroup* cg;
    cg  = new CutoffGroup();
    cg->addAtom(atom);

    //set the local index of this cutoffGroup, global index will be set later
    cg->setLocalIndex(localIndexMan->getNextCutoffGroupIndex());

    return cg;
  }

  void MoleculeCreator::createConstraintPair(Molecule* mol) {

    //add bond constraints
    Molecule::BondIterator bi;
    Bond* bond;
    for (bond = mol->beginBond(bi); bond != NULL; bond = mol->nextBond(bi)) {
        
      BondType* bt = bond->getBondType();

      //class Parent1 {};
      //class Child1 : public Parent {};
      //class Child2 : public Parent {};
      //Child1* ch1 = new Child1();
      //Child2* ch2 = dynamic_cast<Child2*>(ch1); 
      //the dynamic_cast is succeed in above line. A compiler bug?        

      if (typeid(FixedBondType) == typeid(*bt)) {
        FixedBondType* fbt = dynamic_cast<FixedBondType*>(bt);

        ConstraintElem* consElemA = new ConstraintElem(bond->getAtomA());
        ConstraintElem* consElemB = new ConstraintElem(bond->getAtomB());            
        ConstraintPair* consPair = new ConstraintPair(consElemA, consElemB, fbt->getEquilibriumBondLength());
        mol->addConstraintPair(consPair);
      }
    }

    //rigidbody -- rigidbody constraint is not support yet
  }

  void MoleculeCreator::createConstraintElem(Molecule* mol) {

    ConstraintPair* consPair;
    Molecule::ConstraintPairIterator cpi;
    std::set<StuntDouble*> sdSet;
    for (consPair = mol->beginConstraintPair(cpi); consPair != NULL; consPair = mol->nextConstraintPair(cpi)) {

      StuntDouble* sdA = consPair->getConsElem1()->getStuntDouble();            
      if (sdSet.find(sdA) == sdSet.end()){
        sdSet.insert(sdA);
        mol->addConstraintElem(new ConstraintElem(sdA));
      }

      StuntDouble* sdB = consPair->getConsElem2()->getStuntDouble();            
      if (sdSet.find(sdB) == sdSet.end()){
        sdSet.insert(sdB);
        mol->addConstraintElem(new ConstraintElem(sdB));
      }
        
    }

  }
    
}
Revision:	1710
Committed:	Fri May 18 21:44:02 2012 UTC (12 years, 11 months ago) by gezelter
File size:	17917 byte(s)
Log Message:	Added an adapter layer between the AtomType and the rest of the code to handle the bolt-on capabilities of new types. Fixed a long-standing bug in how storageLayout was being set to the maximum possible value. Started to add infrastructure for Polarizable and fluc-Q calculations.
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	246	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	246	* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31	gezelter	1390	*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	246	*/
42
43	gezelter	507	/**
44			* @file MoleculeCreator.cpp
45			* @author tlin
46			* @date 11/04/2004
47			* @time 13:44am
48			* @version 1.0
49			*/
50	gezelter	246
51			#include <cassert>
52	gezelter	809	#include <typeinfo>
53	gezelter	246	#include <set>
54
55			#include "brains/MoleculeCreator.hpp"
56			#include "primitives/GhostBend.hpp"
57	tim	273	#include "primitives/GhostTorsion.hpp"
58	gezelter	1710	#include "types/AtomType.hpp"
59	gezelter	246	#include "types/FixedBondType.hpp"
60			#include "utils/simError.h"
61			#include "utils/StringUtils.hpp"
62
63	gezelter	1390	namespace OpenMD {
64	tim	647
65	gezelter	1277	Molecule* MoleculeCreator::createMolecule(ForceField* ff,
66			MoleculeStamp *molStamp,
67			int stampId, int globalIndex,
68			LocalIndexManager* localIndexMan) {
69	tim	770	Molecule* mol = new Molecule(stampId, globalIndex, molStamp->getName());
70	gezelter	246
71			//create atoms
72			Atom* atom;
73			AtomStamp* currentAtomStamp;
74			int nAtom = molStamp->getNAtoms();
75			for (int i = 0; i < nAtom; ++i) {
76	tim	770	currentAtomStamp = molStamp->getAtomStamp(i);
77	gezelter	507	atom = createAtom(ff, mol, currentAtomStamp, localIndexMan);
78			mol->addAtom(atom);
79	gezelter	246	}
80
81			//create rigidbodies
82			RigidBody* rb;
83			RigidBodyStamp * currentRigidBodyStamp;
84			int nRigidbodies = molStamp->getNRigidBodies();
85
86			for (int i = 0; i < nRigidbodies; ++i) {
87	tim	770	currentRigidBodyStamp = molStamp->getRigidBodyStamp(i);
88	gezelter	1277	rb = createRigidBody(molStamp, mol, currentRigidBodyStamp,
89			localIndexMan);
90	gezelter	507	mol->addRigidBody(rb);
91	gezelter	246	}
92	gezelter	1277
93	gezelter	246	//create bonds
94			Bond* bond;
95			BondStamp* currentBondStamp;
96			int nBonds = molStamp->getNBonds();
97
98			for (int i = 0; i < nBonds; ++i) {
99	tim	770	currentBondStamp = molStamp->getBondStamp(i);
100	gezelter	507	bond = createBond(ff, mol, currentBondStamp);
101			mol->addBond(bond);
102	gezelter	246	}
103
104			//create bends
105			Bend* bend;
106			BendStamp* currentBendStamp;
107			int nBends = molStamp->getNBends();
108			for (int i = 0; i < nBends; ++i) {
109	tim	770	currentBendStamp = molStamp->getBendStamp(i);
110	gezelter	507	bend = createBend(ff, mol, currentBendStamp);
111			mol->addBend(bend);
112	gezelter	246	}
113
114			//create torsions
115			Torsion* torsion;
116			TorsionStamp* currentTorsionStamp;
117			int nTorsions = molStamp->getNTorsions();
118			for (int i = 0; i < nTorsions; ++i) {
119	tim	770	currentTorsionStamp = molStamp->getTorsionStamp(i);
120	gezelter	507	torsion = createTorsion(ff, mol, currentTorsionStamp);
121			mol->addTorsion(torsion);
122	gezelter	246	}
123
124	gezelter	1277	//create inversions
125			Inversion* inversion;
126			InversionStamp* currentInversionStamp;
127			int nInversions = molStamp->getNInversions();
128			for (int i = 0; i < nInversions; ++i) {
129			currentInversionStamp = molStamp->getInversionStamp(i);
130			inversion = createInversion(ff, mol, currentInversionStamp);
131			if (inversion != NULL ) {
132			mol->addInversion(inversion);
133			}
134			}
135
136	gezelter	246	//create cutoffGroups
137			CutoffGroup* cutoffGroup;
138			CutoffGroupStamp* currentCutoffGroupStamp;
139			int nCutoffGroups = molStamp->getNCutoffGroups();
140			for (int i = 0; i < nCutoffGroups; ++i) {
141	tim	770	currentCutoffGroupStamp = molStamp->getCutoffGroupStamp(i);
142	gezelter	1540	cutoffGroup = createCutoffGroup(mol, currentCutoffGroupStamp, localIndexMan);
143	gezelter	507	mol->addCutoffGroup(cutoffGroup);
144	gezelter	246	}
145
146			//every free atom is a cutoff group
147	tim	647	std::vector<Atom*> freeAtoms;
148			std::vector<Atom*>::iterator ai;
149			std::vector<Atom*>::iterator fai;
150	gezelter	246
151			//add all atoms into allAtoms set
152	tim	647	for(atom = mol->beginAtom(fai); atom != NULL; atom = mol->nextAtom(fai)) {
153			freeAtoms.push_back(atom);
154	gezelter	246	}
155
156			Molecule::CutoffGroupIterator ci;
157			CutoffGroup* cg;
158
159	gezelter	1277	for (cg = mol->beginCutoffGroup(ci); cg != NULL;
160			cg = mol->nextCutoffGroup(ci)) {
161
162	gezelter	507	for(atom = cg->beginAtom(ai); atom != NULL; atom = cg->nextAtom(ai)) {
163	gezelter	1277	//erase the atoms belong to cutoff groups from freeAtoms vector
164			freeAtoms.erase(std::remove(freeAtoms.begin(), freeAtoms.end(), atom),
165			freeAtoms.end());
166			}
167	gezelter	246	}
168
169	gezelter	1277	// loop over the free atoms and then create one cutoff group for
170			// every single free atom
171	tim	647
172	gezelter	246	for (fai = freeAtoms.begin(); fai != freeAtoms.end(); ++fai) {
173	gezelter	1540	cutoffGroup = createCutoffGroup(mol, *fai, localIndexMan);
174	gezelter	507	mol->addCutoffGroup(cutoffGroup);
175	gezelter	246	}
176			//create constraints
177			createConstraintPair(mol);
178			createConstraintElem(mol);
179
180			//the construction of this molecule is finished
181			mol->complete();
182	gezelter	1277
183	gezelter	246	return mol;
184	gezelter	507	}
185	gezelter	246
186
187	gezelter	1277	Atom* MoleculeCreator::createAtom(ForceField* ff, Molecule* mol,
188			AtomStamp* stamp,
189			LocalIndexManager* localIndexMan) {
190	gezelter	246	AtomType * atomType;
191			Atom* atom;
192
193			atomType = ff->getAtomType(stamp->getType());
194	gezelter	1277
195	gezelter	246	if (atomType == NULL) {
196	gezelter	507	sprintf(painCave.errMsg, "Can not find Matching Atom Type for[%s]",
197	tim	770	stamp->getType().c_str());
198	gezelter	246
199	gezelter	507	painCave.isFatal = 1;
200			simError();
201	gezelter	246	}
202
203			//below code still have some kind of hard-coding smell
204			if (atomType->isDirectional()){
205	gezelter	507	DirectionalAtom* dAtom;
206	gezelter	1710	dAtom = new DirectionalAtom(atomType);
207	gezelter	507	atom = dAtom;
208	gezelter	246	}
209			else{
210	gezelter	507	atom = new Atom(atomType);
211	gezelter	246	}
212
213			atom->setLocalIndex(localIndexMan->getNextAtomIndex());
214
215			return atom;
216	gezelter	507	}
217	gezelter	1277
218			RigidBody* MoleculeCreator::createRigidBody(MoleculeStamp *molStamp,
219			Molecule* mol,
220	gezelter	507	RigidBodyStamp* rbStamp,
221			LocalIndexManager* localIndexMan) {
222	gezelter	246	Atom* atom;
223			int nAtoms;
224			Vector3d refCoor;
225			AtomStamp* atomStamp;
226
227			RigidBody* rb = new RigidBody();
228			nAtoms = rbStamp->getNMembers();
229			for (int i = 0; i < nAtoms; ++i) {
230	gezelter	1277	//rbStamp->getMember(i) return the local index of current atom
231			//inside the molecule. It is not the same as local index of
232			//atom which is the index of atom at DataStorage class
233	tim	770	atom = mol->getAtomAt(rbStamp->getMemberAt(i));
234			atomStamp= molStamp->getAtomStamp(rbStamp->getMemberAt(i));
235	gezelter	507	rb->addAtom(atom, atomStamp);
236	gezelter	246	}
237
238	gezelter	1277	//after all of the atoms are added, we need to calculate the
239			//reference coordinates
240	gezelter	246	rb->calcRefCoords();
241
242			//set the local index of this rigid body, global index will be set later
243			rb->setLocalIndex(localIndexMan->getNextRigidBodyIndex());
244
245			//the rule for naming rigidbody MoleculeName_RB_Integer
246			//The first part is the name of the molecule
247			//The second part is alway fixed as "RB"
248			//The third part is the index of the rigidbody defined in meta-data file
249			//For example, Butane_RB_0 is a valid rigid body name of butane molecule
250			/*@todo replace itoa by lexi_cast /
251	gezelter	1390	std::string s = OpenMD_itoa(mol->getNRigidBodies(), 10);
252	gezelter	403	rb->setType(mol->getType() + "_RB_" + s.c_str());
253	tim	292
254	gezelter	246	return rb;
255	gezelter	507	}
256	gezelter	246
257	gezelter	1277	Bond* MoleculeCreator::createBond(ForceField* ff, Molecule* mol,
258			BondStamp* stamp) {
259	gezelter	246	BondType* bondType;
260			Atom* atomA;
261			Atom* atomB;
262	gezelter	1277
263	gezelter	246	atomA = mol->getAtomAt(stamp->getA());
264			atomB = mol->getAtomAt(stamp->getB());
265	gezelter	1277
266	gezelter	246	assert( atomA && atomB);
267
268			bondType = ff->getBondType(atomA->getType(), atomB->getType());
269
270			if (bondType == NULL) {
271	gezelter	507	sprintf(painCave.errMsg, "Can not find Matching Bond Type for[%s, %s]",
272			atomA->getType().c_str(),
273			atomB->getType().c_str());
274	gezelter	1277
275	gezelter	507	painCave.isFatal = 1;
276			simError();
277	gezelter	246	}
278			return new Bond(atomA, atomB, bondType);
279	gezelter	507	}
280	gezelter	1277
281			Bend* MoleculeCreator::createBend(ForceField* ff, Molecule* mol,
282			BendStamp* stamp) {
283	tim	770	Bend* bend = NULL;
284			std::vector<int> bendAtoms = stamp->getMembers();
285			if (bendAtoms.size() == 3) {
286			Atom* atomA = mol->getAtomAt(bendAtoms[0]);
287			Atom* atomB = mol->getAtomAt(bendAtoms[1]);
288			Atom* atomC = mol->getAtomAt(bendAtoms[2]);
289	gezelter	1277
290	tim	770	assert( atomA && atomB && atomC);
291	gezelter	1277
292			BendType* bendType = ff->getBendType(atomA->getType().c_str(),
293			atomB->getType().c_str(),
294			atomC->getType().c_str());
295
296	tim	770	if (bendType == NULL) {
297			sprintf(painCave.errMsg, "Can not find Matching Bend Type for[%s, %s, %s]",
298			atomA->getType().c_str(),
299			atomB->getType().c_str(),
300			atomC->getType().c_str());
301	gezelter	1277
302	tim	770	painCave.isFatal = 1;
303			simError();
304	gezelter	507	}
305	gezelter	1277
306	tim	770	bend = new Bend(atomA, atomB, atomC, bendType);
307			} else if ( bendAtoms.size() == 2 && stamp->haveGhostVectorSource()) {
308			int ghostIndex = stamp->getGhostVectorSource();
309			int normalIndex = ghostIndex != bendAtoms[0] ? bendAtoms[0] : bendAtoms[1];
310	gezelter	507	Atom* normalAtom = mol->getAtomAt(normalIndex) ;
311			DirectionalAtom* ghostAtom = dynamic_cast<DirectionalAtom*>(mol->getAtomAt(ghostIndex));
312			if (ghostAtom == NULL) {
313			sprintf(painCave.errMsg, "Can not cast Atom to DirectionalAtom");
314			painCave.isFatal = 1;
315			simError();
316			}
317	gezelter	246
318	gezelter	507	BendType* bendType = ff->getBendType(normalAtom->getType(), ghostAtom->getType(), "GHOST");
319	gezelter	246
320	gezelter	507	if (bendType == NULL) {
321			sprintf(painCave.errMsg, "Can not find Matching Bend Type for[%s, %s, %s]",
322			normalAtom->getType().c_str(),
323			ghostAtom->getType().c_str(),
324			"GHOST");
325	gezelter	246
326	gezelter	507	painCave.isFatal = 1;
327			simError();
328			}
329	gezelter	1277
330	tim	770	bend = new GhostBend(normalAtom, ghostAtom, bendType);
331	gezelter	1277
332	tim	770	}
333
334			return bend;
335			}
336	gezelter	246
337	gezelter	1277	Torsion* MoleculeCreator::createTorsion(ForceField* ff, Molecule* mol,
338			TorsionStamp* stamp) {
339	gezelter	246
340	tim	770	Torsion* torsion = NULL;
341			std::vector<int> torsionAtoms = stamp->getMembers();
342			if (torsionAtoms.size() < 3) {
343			return torsion;
344	gezelter	246	}
345
346	tim	770	Atom* atomA = mol->getAtomAt(torsionAtoms[0]);
347			Atom* atomB = mol->getAtomAt(torsionAtoms[1]);
348			Atom* atomC = mol->getAtomAt(torsionAtoms[2]);
349	gezelter	246
350	tim	770	if (torsionAtoms.size() == 4) {
351			Atom* atomD = mol->getAtomAt(torsionAtoms[3]);
352	gezelter	246
353	gezelter	507	assert(atomA && atomB && atomC && atomD);
354	tim	273
355	gezelter	1277	TorsionType* torsionType = ff->getTorsionType(atomA->getType(),
356			atomB->getType(),
357			atomC->getType(),
358			atomD->getType());
359	gezelter	507	if (torsionType == NULL) {
360			sprintf(painCave.errMsg, "Can not find Matching Torsion Type for[%s, %s, %s, %s]",
361			atomA->getType().c_str(),
362			atomB->getType().c_str(),
363			atomC->getType().c_str(),
364			atomD->getType().c_str());
365	gezelter	1277
366	gezelter	507	painCave.isFatal = 1;
367			simError();
368			}
369	gezelter	1277
370	gezelter	507	torsion = new Torsion(atomA, atomB, atomC, atomD, torsionType);
371	gezelter	246	}
372	tim	273	else {
373	gezelter	1277
374	tim	770	DirectionalAtom* dAtom = dynamic_cast<DirectionalAtom*>(mol->getAtomAt(stamp->getGhostVectorSource()));
375	gezelter	507	if (dAtom == NULL) {
376			sprintf(painCave.errMsg, "Can not cast Atom to DirectionalAtom");
377			painCave.isFatal = 1;
378			simError();
379			}
380	gezelter	1277
381	gezelter	507	TorsionType* torsionType = ff->getTorsionType(atomA->getType(), atomB->getType(),
382			atomC->getType(), "GHOST");
383	gezelter	1277
384	gezelter	507	if (torsionType == NULL) {
385			sprintf(painCave.errMsg, "Can not find Matching Torsion Type for[%s, %s, %s, %s]",
386			atomA->getType().c_str(),
387			atomB->getType().c_str(),
388			atomC->getType().c_str(),
389			"GHOST");
390	gezelter	1277
391	gezelter	507	painCave.isFatal = 1;
392			simError();
393			}
394	gezelter	1277
395	gezelter	507	torsion = new GhostTorsion(atomA, atomB, dAtom, torsionType);
396	tim	273	}
397	gezelter	1277
398	tim	273	return torsion;
399	gezelter	507	}
400	gezelter	246
401	gezelter	1277	Inversion* MoleculeCreator::createInversion(ForceField* ff, Molecule* mol,
402			InversionStamp* stamp) {
403
404			Inversion* inversion = NULL;
405			int center = stamp->getCenter();
406			std::vector<int> satellites = stamp->getSatellites();
407			if (satellites.size() != 3) {
408			return inversion;
409			}
410
411			Atom* atomA = mol->getAtomAt(center);
412			Atom* atomB = mol->getAtomAt(satellites[0]);
413			Atom* atomC = mol->getAtomAt(satellites[1]);
414			Atom* atomD = mol->getAtomAt(satellites[2]);
415
416			assert(atomA && atomB && atomC && atomD);
417
418			InversionType* inversionType = ff->getInversionType(atomA->getType(),
419			atomB->getType(),
420			atomC->getType(),
421			atomD->getType());
422
423			if (inversionType == NULL) {
424			sprintf(painCave.errMsg, "No Matching Inversion Type for[%s, %s, %s, %s]\n"
425			"\t(May not be a problem: not all inversions are parametrized)\n",
426			atomA->getType().c_str(),
427			atomB->getType().c_str(),
428			atomC->getType().c_str(),
429			atomD->getType().c_str());
430
431			painCave.isFatal = 0;
432	gezelter	1390	painCave.severity = OPENMD_INFO;
433	gezelter	1277	simError();
434			return NULL;
435			} else {
436
437			inversion = new Inversion(atomA, atomB, atomC, atomD, inversionType);
438			return inversion;
439			}
440			}
441
442
443	gezelter	1540	CutoffGroup* MoleculeCreator::createCutoffGroup(Molecule* mol,
444			CutoffGroupStamp* stamp,
445			LocalIndexManager* localIndexMan) {
446	gezelter	246	int nAtoms;
447			CutoffGroup* cg;
448			Atom* atom;
449			cg = new CutoffGroup();
450
451			nAtoms = stamp->getNMembers();
452			for (int i =0; i < nAtoms; ++i) {
453	tim	770	atom = mol->getAtomAt(stamp->getMemberAt(i));
454	gezelter	507	assert(atom);
455			cg->addAtom(atom);
456	gezelter	246	}
457	gezelter	1540
458			//set the local index of this cutoffGroup, global index will be set later
459			cg->setLocalIndex(localIndexMan->getNextCutoffGroupIndex());
460
461	gezelter	246	return cg;
462	gezelter	507	}
463	gezelter	1540
464			CutoffGroup* MoleculeCreator::createCutoffGroup(Molecule * mol, Atom* atom,
465			LocalIndexManager* localIndexMan) {
466	gezelter	246	CutoffGroup* cg;
467			cg = new CutoffGroup();
468			cg->addAtom(atom);
469	gezelter	1540
470			//set the local index of this cutoffGroup, global index will be set later
471			cg->setLocalIndex(localIndexMan->getNextCutoffGroupIndex());
472
473	gezelter	246	return cg;
474	gezelter	507	}
475	gezelter	246
476	gezelter	507	void MoleculeCreator::createConstraintPair(Molecule* mol) {
477	gezelter	246
478			//add bond constraints
479			Molecule::BondIterator bi;
480			Bond* bond;
481			for (bond = mol->beginBond(bi); bond != NULL; bond = mol->nextBond(bi)) {
482
483	gezelter	507	BondType* bt = bond->getBondType();
484	gezelter	246
485	gezelter	507	//class Parent1 {};
486			//class Child1 : public Parent {};
487			//class Child2 : public Parent {};
488			//Child1* ch1 = new Child1();
489			//Child2* ch2 = dynamic_cast<Child2*>(ch1);
490			//the dynamic_cast is succeed in above line. A compiler bug?
491	gezelter	246
492	gezelter	507	if (typeid(FixedBondType) == typeid(*bt)) {
493			FixedBondType* fbt = dynamic_cast<FixedBondType*>(bt);
494	gezelter	246
495	gezelter	507	ConstraintElem* consElemA = new ConstraintElem(bond->getAtomA());
496			ConstraintElem* consElemB = new ConstraintElem(bond->getAtomB());
497			ConstraintPair* consPair = new ConstraintPair(consElemA, consElemB, fbt->getEquilibriumBondLength());
498			mol->addConstraintPair(consPair);
499			}
500	gezelter	246	}
501
502			//rigidbody -- rigidbody constraint is not support yet
503	gezelter	507	}
504	gezelter	246
505	gezelter	507	void MoleculeCreator::createConstraintElem(Molecule* mol) {
506	gezelter	246
507			ConstraintPair* consPair;
508			Molecule::ConstraintPairIterator cpi;
509			std::set<StuntDouble*> sdSet;
510			for (consPair = mol->beginConstraintPair(cpi); consPair != NULL; consPair = mol->nextConstraintPair(cpi)) {
511
512	gezelter	507	StuntDouble* sdA = consPair->getConsElem1()->getStuntDouble();
513			if (sdSet.find(sdA) == sdSet.end()){
514			sdSet.insert(sdA);
515			mol->addConstraintElem(new ConstraintElem(sdA));
516			}
517	gezelter	246
518	gezelter	507	StuntDouble* sdB = consPair->getConsElem2()->getStuntDouble();
519			if (sdSet.find(sdB) == sdSet.end()){
520			sdSet.insert(sdB);
521			mol->addConstraintElem(new ConstraintElem(sdB));
522			}
523	gezelter	246
524			}
525
526	gezelter	507	}
527	gezelter	246
528			}