Chemical Data Processing Library C++ API - Version 1.4.0
MMFF94ElectrostaticInteraction.hpp
Go to the documentation of this file.
1 /*
2  * MMFF94ElectrostaticInteraction.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_MMFF94ELECTROSTATICINTERACTION_HPP
30 #define CDPL_FORCEFIELD_MMFF94ELECTROSTATICINTERACTION_HPP
31 
32 #include <cstddef>
33 
34 
35 namespace CDPL
36 {
37 
38  namespace ForceField
39  {
40 
45  {
46 
47  public:
58  MMFF94ElectrostaticInteraction(std::size_t atom1_idx, std::size_t atom2_idx, double atom1_chg,
59  double atom2_chg, double scale_fact, double de_const, double dist_expo):
60  atom1Idx(atom1_idx),
61  atom2Idx(atom2_idx), atom1Chg(atom1_chg), atom2Chg(atom2_chg),
62  scaleFact(scale_fact), deConst(de_const), distExpo(dist_expo) {}
63 
68  std::size_t getAtom1Index() const
69  {
70  return atom1Idx;
71  }
72 
77  std::size_t getAtom2Index() const
78  {
79  return atom2Idx;
80  }
81 
86  double getAtom1Charge() const
87  {
88  return atom1Chg;
89  }
90 
95  double getAtom2Charge() const
96  {
97  return atom2Chg;
98  }
99 
104  double getScalingFactor() const
105  {
106  return scaleFact;
107  }
108 
113  double getDielectricConstant() const
114  {
115  return deConst;
116  }
117 
122  double getDistanceExponent() const
123  {
124  return distExpo;
125  }
126 
127  private:
128  std::size_t atom1Idx;
129  std::size_t atom2Idx;
130  double atom1Chg;
131  double atom2Chg;
132  double scaleFact;
133  double deConst;
134  double distExpo;
135  };
136  } // namespace ForceField
137 } // namespace CDPL
138 
139 #endif // CDPL_FORCEFIELD_MMFF94ELECTROSTATICINTERACTION_HPP
Stores parameters for a single MMFF94 electrostatic interaction between two non-bonded atoms.
Definition: MMFF94ElectrostaticInteraction.hpp:45
double getDistanceExponent() const
Returns the distance exponent of the electrostatic potential.
Definition: MMFF94ElectrostaticInteraction.hpp:122
double getAtom2Charge() const
Returns the partial charge of the second atom.
Definition: MMFF94ElectrostaticInteraction.hpp:95
std::size_t getAtom1Index() const
Returns the zero-based index of the first atom.
Definition: MMFF94ElectrostaticInteraction.hpp:68
double getScalingFactor() const
Returns the scaling factor applied to the energy contribution.
Definition: MMFF94ElectrostaticInteraction.hpp:104
std::size_t getAtom2Index() const
Returns the zero-based index of the second atom.
Definition: MMFF94ElectrostaticInteraction.hpp:77
double getDielectricConstant() const
Returns the dielectric constant used by this interaction.
Definition: MMFF94ElectrostaticInteraction.hpp:113
double getAtom1Charge() const
Returns the partial charge of the first atom.
Definition: MMFF94ElectrostaticInteraction.hpp:86
MMFF94ElectrostaticInteraction(std::size_t atom1_idx, std::size_t atom2_idx, double atom1_chg, double atom2_chg, double scale_fact, double de_const, double dist_expo)
Constructs the electrostatic interaction parameter set.
Definition: MMFF94ElectrostaticInteraction.hpp:58
The namespace of the Chemical Data Processing Library.