src/brains/ForceField.hpp

/*
 * 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]  Vardeman & Gezelter, in progress (2009).                        
 */
 
/**
 * @file ForceField.hpp
 * @author tlin
 * @date 11/04/2004
 * @time 22:51am
 * @version 1.0
 */
  
#ifndef USETHEFORCE_FORCEFIELD_HPP
#define USETHEFORCE_FORCEFIELD_HPP

#include "config.h"
#include <string>
#include <utility>
#include <vector>

#include "io/basic_ifstrstream.hpp"
#include "io/ForceFieldOptions.hpp"
#include "utils/TypeContainer.hpp"
#include "utils/Tuple.hpp"
#include "types/AtomType.hpp"
#include "types/BondType.hpp"
#include "types/BendType.hpp"
#include "types/TorsionType.hpp"
#include "types/InversionType.hpp"
#include "types/NonBondedInteractionType.hpp"
namespace OpenMD {

  /**
   * @class ForceField ForceField.hpp ''UseTheForce/ForceField.hpp"
   * @brief
   */
  class ForceField{

  public:

    typedef TypeContainer<AtomType, 1> AtomTypeContainer;
    typedef TypeContainer<BondType, 2> BondTypeContainer;
    typedef TypeContainer<BendType, 3> BendTypeContainer;
    typedef TypeContainer<TorsionType, 4> TorsionTypeContainer;
    typedef TypeContainer<InversionType, 4> InversionTypeContainer;
    typedef TypeContainer<NonBondedInteractionType, 2> NonBondedInteractionTypeContainer;
    
    ForceField(); 
    
    virtual ~ForceField();

    std::string getForceFieldFileName() {
      return forceFieldFileName_;
    }

    void setForceFieldFileName(const std::string& filename) {
      forceFieldFileName_ = filename;
    }
        
    virtual void parse(const std::string& filename) = 0;  

    AtomType* getAtomType(const std::string &at);
    BondType* getBondType(const std::string &at1, const std::string &at2);
    BendType* getBendType(const std::string &at1, const std::string &at2,
                          const std::string &at3);
    TorsionType* getTorsionType(const std::string &at1, const std::string &at2,
                                const std::string &at3, const std::string &at4);
    InversionType* getInversionType(const std::string &at1, 
                                    const std::string &at2,
                                    const std::string &at3, 
                                    const std::string &at4);
    NonBondedInteractionType* getNonBondedInteractionType(const std::string &at1, const std::string &at2);
    
    BondType* getExactBondType(const std::string &at1, const std::string &at2);
    BendType* getExactBendType(const std::string &at1, const std::string &at2,
                               const std::string &at3);
    TorsionType* getExactTorsionType(const std::string &at1, 
                                     const std::string &at2,
                                     const std::string &at3, 
                                     const std::string &at4);
    InversionType* getExactInversionType(const std::string &at1, 
                                         const std::string &at2,
                                         const std::string &at3, 
                                         const std::string &at4);
    NonBondedInteractionType* getExactNonBondedInteractionType(const std::string &at1, const std::string &at2);
    
    
    //avoid make virtual function public
    //Herb Sutter and Andrei Alexandrescu, C++ coding Standards, Addision-Wesley
    virtual RealType getRcutFromAtomType(AtomType* at);
    
    std::string getWildCard() {
      return wildCardAtomTypeName_;
    }
    
    void setWildCard(const std::string& wildCard) {
      wildCardAtomTypeName_ = wildCard;
    }
    
    unsigned int getNAtomType() {
      return atomTypeCont_.size();
    }

    AtomTypeContainer* getAtomTypes() {
      return &atomTypeCont_;
    }
    
    NonBondedInteractionTypeContainer* getNonBondedInteractionTypes() {
      return &nonBondedInteractionTypeCont_;
    }
        
    bool addAtomType(const std::string &at, AtomType* atomType);

    bool replaceAtomType(const std::string &at, AtomType* atomType);

    bool addBondType(const std::string &at1, const std::string &at2, 
                     BondType* bondType);

    bool addBendType(const std::string &at1, const std::string &at2,
                     const std::string &at3, BendType* bendType);

    bool addTorsionType(const std::string &at1, const std::string &at2,
                        const std::string &at3, const std::string &at4, 
                        TorsionType* torsionType);

    bool addInversionType(const std::string &at1, const std::string &at2,
                          const std::string &at3, const std::string &at4,
                          InversionType* inversionType);
    
    bool addNonBondedInteractionType(const std::string &at1, 
                                     const std::string &at2, 
                                     NonBondedInteractionType* nbiType);
    
    ifstrstream* openForceFieldFile(const std::string& filename);
    
    ForceFieldOptions& getForceFieldOptions() {return forceFieldOptions_;}

    void setFortranForceOptions(void);

 
  protected:

    AtomTypeContainer atomTypeCont_;    
    BondTypeContainer bondTypeCont_;
    BendTypeContainer bendTypeCont_;
    TorsionTypeContainer torsionTypeCont_;
    InversionTypeContainer inversionTypeCont_;
    NonBondedInteractionTypeContainer nonBondedInteractionTypeCont_;
    ForceFieldOptions forceFieldOptions_;
    
  private:  
    std::string ffPath_;
    
    std::string wildCardAtomTypeName_;
    
    std::string forceFieldFileName_;    
    
  };
}//end namespace OpenMD
#endif

Revision:	1530
Committed:	Tue Dec 28 21:47:55 2010 UTC (14 years, 4 months ago) by gezelter
Original Path:	*branches/development/src/UseTheForce/ForceField.hpp*
File size:	7172 byte(s)
Log Message:	Moved switching functions and force options over to the C++ side, and removed them from Fortran.
#	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			* [4] Vardeman & Gezelter, in progress (2009).
40	gezelter	246	*/
41
42	gezelter	507	/**
43			* @file ForceField.hpp
44			* @author tlin
45			* @date 11/04/2004
46			* @time 22:51am
47			* @version 1.0
48			*/
49	gezelter	246
50	gezelter	206	#ifndef USETHEFORCE_FORCEFIELD_HPP
51			#define USETHEFORCE_FORCEFIELD_HPP
52
53	gezelter	762	#include "config.h"
54	gezelter	246	#include <string>
55			#include <utility>
56	gezelter	1269	#include <vector>
57	gezelter	206
58			#include "io/basic_ifstrstream.hpp"
59	tim	749	#include "io/ForceFieldOptions.hpp"
60	gezelter	246	#include "utils/TypeContainer.hpp"
61	gezelter	1269	#include "utils/Tuple.hpp"
62	gezelter	246	#include "types/AtomType.hpp"
63			#include "types/BondType.hpp"
64			#include "types/BendType.hpp"
65			#include "types/TorsionType.hpp"
66	cli2	1275	#include "types/InversionType.hpp"
67	chuckv	1151	#include "types/NonBondedInteractionType.hpp"
68	gezelter	1390	namespace OpenMD {
69	gezelter	206
70	gezelter	507	/**
71			* @class ForceField ForceField.hpp ''UseTheForce/ForceField.hpp"
72			* @brief
73			*/
74			class ForceField{
75	gezelter	206
76	gezelter	507	public:
77	gezelter	206
78	gezelter	507	typedef TypeContainer<AtomType, 1> AtomTypeContainer;
79			typedef TypeContainer<BondType, 2> BondTypeContainer;
80			typedef TypeContainer<BendType, 3> BendTypeContainer;
81			typedef TypeContainer<TorsionType, 4> TorsionTypeContainer;
82	cli2	1275	typedef TypeContainer<InversionType, 4> InversionTypeContainer;
83			typedef TypeContainer<NonBondedInteractionType, 2> NonBondedInteractionTypeContainer;
84
85	gezelter	507	ForceField();
86	cli2	1275
87	gezelter	507	virtual ~ForceField();
88	gezelter	206
89	gezelter	507	std::string getForceFieldFileName() {
90			return forceFieldFileName_;
91			}
92	gezelter	206
93	gezelter	507	void setForceFieldFileName(const std::string& filename) {
94			forceFieldFileName_ = filename;
95			}
96	gezelter	246
97	gezelter	507	virtual void parse(const std::string& filename) = 0;
98	gezelter	206
99	gezelter	507	AtomType* getAtomType(const std::string &at);
100			BondType* getBondType(const std::string &at1, const std::string &at2);
101			BendType* getBendType(const std::string &at1, const std::string &at2,
102	chrisfen	514	const std::string &at3);
103	gezelter	507	TorsionType* getTorsionType(const std::string &at1, const std::string &at2,
104	chrisfen	514	const std::string &at3, const std::string &at4);
105	cli2	1275	InversionType* getInversionType(const std::string &at1,
106			const std::string &at2,
107			const std::string &at3,
108			const std::string &at4);
109			NonBondedInteractionType* getNonBondedInteractionType(const std::string &at1, const std::string &at2);
110
111	gezelter	507	BondType* getExactBondType(const std::string &at1, const std::string &at2);
112			BendType* getExactBendType(const std::string &at1, const std::string &at2,
113	chrisfen	514	const std::string &at3);
114			TorsionType* getExactTorsionType(const std::string &at1,
115			const std::string &at2,
116			const std::string &at3,
117			const std::string &at4);
118	cli2	1275	InversionType* getExactInversionType(const std::string &at1,
119			const std::string &at2,
120			const std::string &at3,
121			const std::string &at4);
122			NonBondedInteractionType* getExactNonBondedInteractionType(const std::string &at1, const std::string &at2);
123
124
125	gezelter	507	//avoid make virtual function public
126			//Herb Sutter and Andrei Alexandrescu, C++ coding Standards, Addision-Wesley
127	tim	963	virtual RealType getRcutFromAtomType(AtomType* at);
128	cli2	1275
129	gezelter	507	std::string getWildCard() {
130			return wildCardAtomTypeName_;
131			}
132	cli2	1275
133	gezelter	507	void setWildCard(const std::string& wildCard) {
134			wildCardAtomTypeName_ = wildCard;
135			}
136	cli2	1275
137	gezelter	507	unsigned int getNAtomType() {
138			return atomTypeCont_.size();
139			}
140	gezelter	1467
141	gezelter	1476	AtomTypeContainer* getAtomTypes() {
142			return &atomTypeCont_;
143	gezelter	1467	}
144
145	gezelter	1476	NonBondedInteractionTypeContainer* getNonBondedInteractionTypes() {
146			return &nonBondedInteractionTypeCont_;
147	gezelter	1467	}
148	gezelter	246
149	gezelter	507	bool addAtomType(const std::string &at, AtomType* atomType);
150	gezelter	246
151	gezelter	1282	bool replaceAtomType(const std::string &at, AtomType* atomType);
152
153	chrisfen	514	bool addBondType(const std::string &at1, const std::string &at2,
154			BondType* bondType);
155	gezelter	246
156	gezelter	507	bool addBendType(const std::string &at1, const std::string &at2,
157			const std::string &at3, BendType* bendType);
158	gezelter	246
159	gezelter	507	bool addTorsionType(const std::string &at1, const std::string &at2,
160	cli2	1275	const std::string &at3, const std::string &at4,
161			TorsionType* torsionType);
162	gezelter	246
163	cli2	1275	bool addInversionType(const std::string &at1, const std::string &at2,
164			const std::string &at3, const std::string &at4,
165			InversionType* inversionType);
166
167			bool addNonBondedInteractionType(const std::string &at1,
168			const std::string &at2,
169			NonBondedInteractionType* nbiType);
170
171	gezelter	507	ifstrstream* openForceFieldFile(const std::string& filename);
172	cli2	1275
173	tim	749	ForceFieldOptions& getForceFieldOptions() {return forceFieldOptions_;}
174	chuckv	821
175			void setFortranForceOptions(void);
176	gezelter	1269
177
178	gezelter	507	protected:
179	gezelter	246
180	gezelter	507	AtomTypeContainer atomTypeCont_;
181			BondTypeContainer bondTypeCont_;
182			BendTypeContainer bendTypeCont_;
183			TorsionTypeContainer torsionTypeCont_;
184	cli2	1275	InversionTypeContainer inversionTypeCont_;
185	chuckv	1151	NonBondedInteractionTypeContainer nonBondedInteractionTypeCont_;
186	tim	749	ForceFieldOptions forceFieldOptions_;
187
188	gezelter	507	private:
189			std::string ffPath_;
190	cli2	1275
191	gezelter	507	std::string wildCardAtomTypeName_;
192	cli2	1275
193			std::string forceFieldFileName_;
194
195	gezelter	507	};
196	gezelter	1390	}//end namespace OpenMD
197	gezelter	206	#endif
198