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 
46  {
47 
48  public:
59  MMFF94ElectrostaticInteraction(std::size_t atom1_idx, std::size_t atom2_idx, double atom1_chg,
60  double atom2_chg, double scale_fact, double de_const, double dist_expo):
61  atom1Idx(atom1_idx),
62  atom2Idx(atom2_idx), atom1Chg(atom1_chg), atom2Chg(atom2_chg),
63  scaleFact(scale_fact), deConst(de_const), distExpo(dist_expo) {}
64 
69  std::size_t getAtom1Index() const
70  {
71  return atom1Idx;
72  }
73 
78  std::size_t getAtom2Index() const
79  {
80  return atom2Idx;
81  }
82 
87  double getAtom1Charge() const
88  {
89  return atom1Chg;
90  }
91 
96  double getAtom2Charge() const
97  {
98  return atom2Chg;
99  }
100 
105  double getScalingFactor() const
106  {
107  return scaleFact;
108  }
109 
114  double getDielectricConstant() const
115  {
116  return deConst;
117  }
118 
123  double getDistanceExponent() const
124  {
125  return distExpo;
126  }
127 
128  private:
129  std::size_t atom1Idx;
130  std::size_t atom2Idx;
131  double atom1Chg;
132  double atom2Chg;
133  double scaleFact;
134  double deConst;
135  double distExpo;
136  };
137  } // namespace ForceField
138 } // namespace CDPL
139 
140 #endif // CDPL_FORCEFIELD_MMFF94ELECTROSTATICINTERACTION_HPP
Stores parameters for a single MMFF94 electrostatic interaction between two non-bonded atoms.
Definition: MMFF94ElectrostaticInteraction.hpp:46
double getDistanceExponent() const
Returns the distance exponent of the electrostatic potential.
Definition: MMFF94ElectrostaticInteraction.hpp:123
double getAtom2Charge() const
Returns the partial charge of the second atom.
Definition: MMFF94ElectrostaticInteraction.hpp:96
std::size_t getAtom1Index() const
Returns the zero-based index of the first atom.
Definition: MMFF94ElectrostaticInteraction.hpp:69
double getScalingFactor() const
Returns the scaling factor applied to the energy contribution.
Definition: MMFF94ElectrostaticInteraction.hpp:105
std::size_t getAtom2Index() const
Returns the zero-based index of the second atom.
Definition: MMFF94ElectrostaticInteraction.hpp:78
double getDielectricConstant() const
Returns the dielectric constant used by this interaction.
Definition: MMFF94ElectrostaticInteraction.hpp:114
double getAtom1Charge() const
Returns the partial charge of the first atom.
Definition: MMFF94ElectrostaticInteraction.hpp:87
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:59
The namespace of the Chemical Data Processing Library.