src/UseTheForce/SC_FF.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.
 *
 *
 *  SC_FF.cpp
 *  OOPSE-2.0
 *
 *  Created by Charles F. Vardeman II on 11/9/05.
 *  @author  Charles F. Vardeman II 
 *  @version $Id: SC_FF.cpp,v 1.3 2005-11-16 21:37:43 chuckv Exp $
 *
 */

#include "UseTheForce/SC_FF.hpp"
#include "UseTheForce/DarkSide/eam_interface.h"
#include "UseTheForce/DarkSide/lj_interface.h"
#include "UseTheForce/DarkSide/sticky_interface.h"
#include "UseTheForce/DarkSide/suttonchen_interface.h"
#include "UseTheForce/ForceFieldFactory.hpp"
#include "io/DirectionalAtomTypesSectionParser.hpp"
#include "io/AtomTypesSectionParser.hpp"
#include "io/LennardJonesAtomTypesSectionParser.hpp"
#include "io/ChargeAtomTypesSectionParser.hpp"
#include "io/MultipoleAtomTypesSectionParser.hpp"
#include "io/EAMAtomTypesSectionParser.hpp"
#include "io/StickyAtomTypesSectionParser.hpp"
#include "io/BondTypesSectionParser.hpp"
#include "io/BendTypesSectionParser.hpp"
#include "io/TorsionTypesSectionParser.hpp"
#include "io/SCAtomTypesSectionParser.hpp"
#include "UseTheForce/ForceFieldCreator.hpp"
#include "utils/simError.h"
namespace oopse {
  
  SC_FF::SC_FF(){
    
    //set default force field filename
    setForceFieldFileName("SuttonChen.QSC.frc");
    
    //the order of adding section parsers are important
    //DirectionalAtomTypesSectionParser should be added before AtomTypesSectionParser Since
    //These two section parsers will actually create "real" AtomTypes (AtomTypesSectionParser will create
    //AtomType and DirectionalAtomTypesSectionParser will creat DirectionalAtomType which is a subclass
    //of AtomType, therefore it should come first). Other AtomTypes Section Parser will not create the 
    //"real" AtomType, they only add and set some attribute of the AtomType. Thus their order are not
    //important. AtomTypesSectionParser should be added before other atom type section parsers.
    //Make sure they are added after DirectionalAtomTypesSectionParser and AtomTypesSectionParser. 
    //The order of BondTypesSectionParser, BendTypesSectionParser and TorsionTypesSectionParser are
    //not important.
    spMan_.push_back(new DirectionalAtomTypesSectionParser());
    spMan_.push_back(new AtomTypesSectionParser());
    spMan_.push_back(new SCAtomTypesSectionParser());
    
  }
  
  void SC_FF::parse(const std::string& filename) {
    ifstrstream* ffStream;
    ffStream = openForceFieldFile(filename);
    
    spMan_.parse(*ffStream, *this);
    
    ForceField::AtomTypeContainer::MapTypeIterator i;
    AtomType* at;
    
    for (at = atomTypeCont_.beginType(i); at != NULL; at = atomTypeCont_.nextType(i)) {
      at->makeFortranAtomType();
    }
    
    for (at = atomTypeCont_.beginType(i); at != NULL; at = atomTypeCont_.nextType(i)) {
      at->complete();
    }
    
    delete ffStream;
  }
  
    
  SC_FF::~SC_FF(){
    // We need to clean up the fortran side so we don't have bad things happen if
    // we try to create a second SC force field.
    destroySCTypes();
  }
} //end namespace oopse

Revision:	748
Committed:	Wed Nov 16 21:37:45 2005 UTC (19 years, 11 months ago) by chuckv
File size:	5056 byte(s)
Log Message:	ForceField optional parameters....
#	User	Rev	Content
1	chuckv	728	/*
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			* SC_FF.cpp
43			* OOPSE-2.0
44			*
45			* Created by Charles F. Vardeman II on 11/9/05.
46			* @author Charles F. Vardeman II
47	chuckv	748	* @version $Id: SC_FF.cpp,v 1.3 2005-11-16 21:37:43 chuckv Exp $
48	chuckv	728	*
49			*/
50
51			#include "UseTheForce/SC_FF.hpp"
52			#include "UseTheForce/DarkSide/eam_interface.h"
53			#include "UseTheForce/DarkSide/lj_interface.h"
54			#include "UseTheForce/DarkSide/sticky_interface.h"
55			#include "UseTheForce/DarkSide/suttonchen_interface.h"
56			#include "UseTheForce/ForceFieldFactory.hpp"
57			#include "io/DirectionalAtomTypesSectionParser.hpp"
58			#include "io/AtomTypesSectionParser.hpp"
59			#include "io/LennardJonesAtomTypesSectionParser.hpp"
60			#include "io/ChargeAtomTypesSectionParser.hpp"
61			#include "io/MultipoleAtomTypesSectionParser.hpp"
62			#include "io/EAMAtomTypesSectionParser.hpp"
63			#include "io/StickyAtomTypesSectionParser.hpp"
64			#include "io/BondTypesSectionParser.hpp"
65			#include "io/BendTypesSectionParser.hpp"
66			#include "io/TorsionTypesSectionParser.hpp"
67			#include "io/SCAtomTypesSectionParser.hpp"
68			#include "UseTheForce/ForceFieldCreator.hpp"
69			#include "utils/simError.h"
70			namespace oopse {
71
72			SC_FF::SC_FF(){
73
74			//set default force field filename
75			setForceFieldFileName("SuttonChen.QSC.frc");
76
77			//the order of adding section parsers are important
78			//DirectionalAtomTypesSectionParser should be added before AtomTypesSectionParser Since
79			//These two section parsers will actually create "real" AtomTypes (AtomTypesSectionParser will create
80			//AtomType and DirectionalAtomTypesSectionParser will creat DirectionalAtomType which is a subclass
81			//of AtomType, therefore it should come first). Other AtomTypes Section Parser will not create the
82			//"real" AtomType, they only add and set some attribute of the AtomType. Thus their order are not
83			//important. AtomTypesSectionParser should be added before other atom type section parsers.
84			//Make sure they are added after DirectionalAtomTypesSectionParser and AtomTypesSectionParser.
85			//The order of BondTypesSectionParser, BendTypesSectionParser and TorsionTypesSectionParser are
86			//not important.
87			spMan_.push_back(new DirectionalAtomTypesSectionParser());
88			spMan_.push_back(new AtomTypesSectionParser());
89			spMan_.push_back(new SCAtomTypesSectionParser());
90
91			}
92
93			void SC_FF::parse(const std::string& filename) {
94			ifstrstream* ffStream;
95			ffStream = openForceFieldFile(filename);
96
97			spMan_.parse(ffStream, this);
98
99			ForceField::AtomTypeContainer::MapTypeIterator i;
100			AtomType* at;
101
102			for (at = atomTypeCont_.beginType(i); at != NULL; at = atomTypeCont_.nextType(i)) {
103			at->makeFortranAtomType();
104			}
105
106			for (at = atomTypeCont_.beginType(i); at != NULL; at = atomTypeCont_.nextType(i)) {
107			at->complete();
108			}
109
110			delete ffStream;
111			}
112
113
114			SC_FF::~SC_FF(){
115			// We need to clean up the fortran side so we don't have bad things happen if
116	chuckv	735	// we try to create a second SC force field.
117	chuckv	728	destroySCTypes();
118			}
119			} //end namespace oopse
120