ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/OOPSE-4/src/UseTheForce/ForceField.hpp
(Generate patch)

Comparing trunk/OOPSE-4/src/UseTheForce/ForceField.hpp (file contents):
Revision 1711 by gezelter, Thu Nov 4 20:51:23 2004 UTC vs.
Revision 2448 by tim, Wed Nov 16 23:10:02 2005 UTC

# Line 1 | Line 1
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 ForceField.hpp
44 + * @author tlin
45 + * @date 11/04/2004
46 + * @time 22:51am
47 + * @version 1.0
48 + */
49 +  
50   #ifndef USETHEFORCE_FORCEFIELD_HPP
51   #define USETHEFORCE_FORCEFIELD_HPP
52  
53   #define MK_STR(s) # s
54   #define STR_DEFINE(t, s) t = MK_STR(s)
55  
56 < #include <utilities>
56 > #include <string>
57 > #include <utility>
58  
9 – #include "utils/Tuple.hpp"
10 – #include "types/ShapeAtomType.hpp"
59   #include "io/basic_ifstrstream.hpp"
60 + #include "io/ForceFieldOptions.hpp"
61 + #include "utils/TypeContainer.hpp"
62 + #include "types/AtomType.hpp"
63 + #include "types/BondType.hpp"
64 + #include "types/BendType.hpp"
65 + #include "types/TorsionType.hpp"
66  
67 < using namespace std;
14 < using namespace oopse;
67 > namespace oopse {
68  
69 < class ForceField{
69 >  /**
70 >   * @class ForceField ForceField.hpp ''UseTheForce/ForceField.hpp"
71 >   * @brief
72 >   */
73 >  class ForceField{
74  
75 < public:
75 >  public:
76  
77 <  ForceField(){
78 <    hasVariant=false;
79 <    ffPath = getenv("FORCE_PARAM_PATH");
80 <    if( ffPath.empty() ) {
81 <      STR_DEFINE(ffPath, FRC_PATH );
82 <    }  
26 <  }
77 >    typedef TypeContainer<AtomType, 1> AtomTypeContainer;
78 >    typedef TypeContainer<BondType, 2> BondTypeContainer;
79 >    typedef TypeContainer<BendType, 3> BendTypeContainer;
80 >    typedef TypeContainer<TorsionType, 4> TorsionTypeContainer;
81 >        
82 >    ForceField();
83  
84 <  virtual ~ForceFields(){}
84 >    virtual ~ForceField();
85  
86 <  void setVariant(const string &variant) { hasVariant = true; theVariant = variant; }
87 <  virtual void readParams( void ) = 0;  
88 <  
33 <  AtomType* getMatchingAtomType(const string &at);
34 <  BondType* getMatchingBondType(const string &at1, const string &at2);
35 <  BendType* getMatchingBendType(const string &at1, const string &at2,
36 <                                const string &at3);
37 <  TorsionType* getMatchingTorsionType(const string &at1, const string &at2,
38 <                                      const string &at3, const string &at4);
86 >    std::string getForceFieldFileName() {
87 >      return forceFieldFileName_;
88 >    }
89  
90 <  double getRcutForAtomType(AtomType* at);
91 <  
92 < protected:
93 <  
94 <  string ffPath;
45 <  ifstrstream forceFile;
46 <  bool hasVariant;
47 <  string variant;
48 <  map<string, AtomType*> atomTypeMap;
49 <  map<pair<string,string>, BondType*> bondTypeMap;
50 <  map<tuple3<string,string,string>, BendType*> bendTypeMap;
51 <  map<tuple4<string,string,string,string>, TorsionType*> torsionTypeMap;
52 <  string wildCardAtomTypeName;
90 >    void setForceFieldFileName(const std::string& filename) {
91 >      forceFieldFileName_ = filename;
92 >    }
93 >        
94 >    virtual void parse(const std::string& filename) = 0;  
95  
96 < };
96 >    AtomType* getAtomType(const std::string &at);
97 >    BondType* getBondType(const std::string &at1, const std::string &at2);
98 >    BendType* getBendType(const std::string &at1, const std::string &at2,
99 >                          const std::string &at3);
100 >    TorsionType* getTorsionType(const std::string &at1, const std::string &at2,
101 >                                const std::string &at3, const std::string &at4);
102  
103 +    BondType* getExactBondType(const std::string &at1, const std::string &at2);
104 +    BendType* getExactBendType(const std::string &at1, const std::string &at2,
105 +                               const std::string &at3);
106 +    TorsionType* getExactTorsionType(const std::string &at1,
107 +                                     const std::string &at2,
108 +                                     const std::string &at3,
109 +                                     const std::string &at4);
110  
111 +
112 +    //avoid make virtual function public
113 +    //Herb Sutter and Andrei Alexandrescu, C++ coding Standards, Addision-Wesley
114 +    virtual double getRcutFromAtomType(AtomType* at);
115 +
116 +    std::string getWildCard() {
117 +      return wildCardAtomTypeName_;
118 +    }
119 +
120 +    void setWildCard(const std::string& wildCard) {
121 +      wildCardAtomTypeName_ = wildCard;
122 +    }
123 +
124 +
125 +    unsigned int getNAtomType() {
126 +      return atomTypeCont_.size();
127 +    }
128 +        
129 +    bool addAtomType(const std::string &at, AtomType* atomType);
130 +
131 +    bool addBondType(const std::string &at1, const std::string &at2,
132 +                     BondType* bondType);
133 +
134 +    bool addBendType(const std::string &at1, const std::string &at2,
135 +                     const std::string &at3, BendType* bendType);
136 +
137 +    bool addTorsionType(const std::string &at1, const std::string &at2,
138 +                        const std::string &at3, const std::string &at4, TorsionType* torsionType);
139 +
140 +    ifstrstream* openForceFieldFile(const std::string& filename);
141 +
142 +    ForceFieldOptions& getForceFieldOptions() {return forceFieldOptions_;}
143 +  protected:
144 +
145 +    AtomTypeContainer atomTypeCont_;    
146 +    BondTypeContainer bondTypeCont_;
147 +    BendTypeContainer bendTypeCont_;
148 +    TorsionTypeContainer torsionTypeCont_;
149 +    ForceFieldOptions forceFieldOptions_;
150 +    
151 +  private:  
152 +    std::string ffPath_;
153 +
154 +    std::string wildCardAtomTypeName_;
155 +
156 +    std::string forceFieldFileName_;
157 +  };
158 +
159 +
160 + }//end namespace oopse
161   #endif
162  

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines