Chemical Data Processing Library C++ API - Version 1.0.0
MMFF94StretchBendInteraction.hpp
Go to the documentation of this file.
1 /*
2  * MMFF94StretchBendInteraction.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_FORCEFIELD_MMFF94STRETCHBENDINTERACTION_HPP
30 #define CDPL_FORCEFIELD_MMFF94STRETCHBENDINTERACTION_HPP
31 
32 #include <cstddef>
33 
35 
36 
37 namespace CDPL
38 {
39 
40  namespace ForceField
41  {
42 
44  {
45 
46  public:
47  MMFF94StretchBendInteraction(std::size_t term_atom1_idx, std::size_t ctr_atom_idx, std::size_t term_atom2_idx,
48  unsigned int sb_type_idx, double ref_angle, double ref_length1, double ref_length2,
49  double ijk_force_const, double kji_force_const):
50  termAtom1Idx(term_atom1_idx),
51  ctrAtomIdx(ctr_atom_idx), termAtom2Idx(term_atom2_idx),
52  sbTypeIdx(sb_type_idx), refAngle(ref_angle), refLength1(ref_length1), refLength2(ref_length2),
53  ijkForceConst(ijk_force_const), kjiForceConst(kji_force_const) {}
54 
55  std::size_t getTerminalAtom1Index() const
56  {
57  return termAtom1Idx;
58  }
59 
60  std::size_t getCenterAtomIndex() const
61  {
62  return ctrAtomIdx;
63  }
64 
65  std::size_t getTerminalAtom2Index() const
66  {
67  return termAtom2Idx;
68  }
69 
70  std::size_t getAtom1Index() const
71  {
72  return termAtom1Idx;
73  }
74 
75  std::size_t getAtom2Index() const
76  {
77  return ctrAtomIdx;
78  }
79 
80  std::size_t getAtom3Index() const
81  {
82  return termAtom2Idx;
83  }
84 
85  unsigned int getStretchBendTypeIndex() const
86  {
87  return sbTypeIdx;
88  }
89 
90  double getIJKForceConstant() const
91  {
92  return ijkForceConst;
93  }
94 
95  double getKJIForceConstant() const
96  {
97  return kjiForceConst;
98  }
99 
100  double getReferenceAngle() const
101  {
102  return refAngle;
103  }
104 
105  void setReferenceAngle(double angle)
106  {
107  refAngle = angle;
108  }
109 
110  double getReferenceLength1() const
111  {
112  return refLength1;
113  }
114 
116  {
117  refLength1 = length;
118  }
119 
120  double getReferenceLength2() const
121  {
122  return refLength2;
123  }
124 
126  {
127  refLength2 = length;
128  }
129 
130  private:
131  std::size_t termAtom1Idx;
132  std::size_t ctrAtomIdx;
133  std::size_t termAtom2Idx;
134  unsigned int sbTypeIdx;
135  double refAngle;
136  double refLength1;
137  double refLength2;
138  double ijkForceConst;
139  double kjiForceConst;
140  };
141  } // namespace ForceField
142 } // namespace CDPL
143 
144 #endif // CDPL_FORCEFIELD_MMFF94STRETCHBENDINTERACTION_HPP
CDPL::ForceField::MMFF94StretchBendInteraction::setReferenceAngle
void setReferenceAngle(double angle)
Definition: MMFF94StretchBendInteraction.hpp:105
APIPrefix.hpp
Definition of the preprocessor macro CDPL_FORCEFIELD_API.
CDPL::ForceField::MMFF94StretchBendInteraction::getReferenceLength1
double getReferenceLength1() const
Definition: MMFF94StretchBendInteraction.hpp:110
CDPL::ForceField::MMFF94StretchBendInteraction::setReferenceLength1
void setReferenceLength1(double length)
Definition: MMFF94StretchBendInteraction.hpp:115
CDPL::ForceField::MMFF94StretchBendInteraction::getAtom1Index
std::size_t getAtom1Index() const
Definition: MMFF94StretchBendInteraction.hpp:70
CDPL::ForceField::MMFF94StretchBendInteraction::getAtom3Index
std::size_t getAtom3Index() const
Definition: MMFF94StretchBendInteraction.hpp:80
CDPL::ForceField::MMFF94StretchBendInteraction
Definition: MMFF94StretchBendInteraction.hpp:44
CDPL::ForceField::MMFF94StretchBendInteraction::getCenterAtomIndex
std::size_t getCenterAtomIndex() const
Definition: MMFF94StretchBendInteraction.hpp:60
CDPL::ForceField::MMFF94StretchBendInteraction::getTerminalAtom2Index
std::size_t getTerminalAtom2Index() const
Definition: MMFF94StretchBendInteraction.hpp:65
CDPL::ForceField::MMFF94StretchBendInteraction::MMFF94StretchBendInteraction
MMFF94StretchBendInteraction(std::size_t term_atom1_idx, std::size_t ctr_atom_idx, std::size_t term_atom2_idx, unsigned int sb_type_idx, double ref_angle, double ref_length1, double ref_length2, double ijk_force_const, double kji_force_const)
Definition: MMFF94StretchBendInteraction.hpp:47
CDPL::ForceField::MMFF94StretchBendInteraction::getIJKForceConstant
double getIJKForceConstant() const
Definition: MMFF94StretchBendInteraction.hpp:90
CDPL::ForceField::MMFF94StretchBendInteraction::getReferenceLength2
double getReferenceLength2() const
Definition: MMFF94StretchBendInteraction.hpp:120
CDPL::ForceField::MMFF94StretchBendInteraction::getReferenceAngle
double getReferenceAngle() const
Definition: MMFF94StretchBendInteraction.hpp:100
CDPL
The namespace of the Chemical Data Processing Library.
CDPL::ForceField::MMFF94StretchBendInteraction::getAtom2Index
std::size_t getAtom2Index() const
Definition: MMFF94StretchBendInteraction.hpp:75
CDPL::ForceField::MMFF94StretchBendInteraction::getTerminalAtom1Index
std::size_t getTerminalAtom1Index() const
Definition: MMFF94StretchBendInteraction.hpp:55
CDPL::ForceField::MMFF94StretchBendInteraction::setReferenceLength2
void setReferenceLength2(double length)
Definition: MMFF94StretchBendInteraction.hpp:125
CDPL_FORCEFIELD_API
#define CDPL_FORCEFIELD_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
CDPL::ForceField::MMFF94StretchBendInteraction::getKJIForceConstant
double getKJIForceConstant() const
Definition: MMFF94StretchBendInteraction.hpp:95
CDPL::ForceField::MMFF94StretchBendInteraction::getStretchBendTypeIndex
unsigned int getStretchBendTypeIndex() const
Definition: MMFF94StretchBendInteraction.hpp:85
CDPL::Math::length
VectorNorm2< E >::ResultType length(const VectorExpression< E > &e)
Definition: VectorExpression.hpp:553