Chemical Data Processing Library C++ API - Version 1.1.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 
35 
36 
37 namespace CDPL
38 {
39 
40  namespace ForceField
41  {
42 
44  {
45 
46  public:
47  MMFF94ElectrostaticInteraction(std::size_t atom1_idx, std::size_t atom2_idx, double atom1_chg,
48  double atom2_chg, double scale_fact, double de_const, double dist_expo):
49  atom1Idx(atom1_idx),
50  atom2Idx(atom2_idx), atom1Chg(atom1_chg), atom2Chg(atom2_chg),
51  scaleFact(scale_fact), deConst(de_const), distExpo(dist_expo) {}
52 
53  std::size_t getAtom1Index() const
54  {
55  return atom1Idx;
56  }
57 
58  std::size_t getAtom2Index() const
59  {
60  return atom2Idx;
61  }
62 
63  double getAtom1Charge() const
64  {
65  return atom1Chg;
66  }
67 
68  double getAtom2Charge() const
69  {
70  return atom2Chg;
71  }
72 
73  double getScalingFactor() const
74  {
75  return scaleFact;
76  }
77 
78  double getDielectricConstant() const
79  {
80  return deConst;
81  }
82 
83  double getDistanceExponent() const
84  {
85  return distExpo;
86  }
87 
88  private:
89  std::size_t atom1Idx;
90  std::size_t atom2Idx;
91  double atom1Chg;
92  double atom2Chg;
93  double scaleFact;
94  double deConst;
95  double distExpo;
96  };
97  } // namespace ForceField
98 } // namespace CDPL
99 
100 #endif // CDPL_FORCEFIELD_MMFF94ELECTROSTATICINTERACTION_HPP
APIPrefix.hpp
Definition of the preprocessor macro CDPL_FORCEFIELD_API.
CDPL::ForceField::MMFF94ElectrostaticInteraction::getAtom2Charge
double getAtom2Charge() const
Definition: MMFF94ElectrostaticInteraction.hpp:68
CDPL::ForceField::MMFF94ElectrostaticInteraction::getDielectricConstant
double getDielectricConstant() const
Definition: MMFF94ElectrostaticInteraction.hpp:78
CDPL::ForceField::MMFF94ElectrostaticInteraction::getDistanceExponent
double getDistanceExponent() const
Definition: MMFF94ElectrostaticInteraction.hpp:83
CDPL::ForceField::MMFF94ElectrostaticInteraction::getAtom2Index
std::size_t getAtom2Index() const
Definition: MMFF94ElectrostaticInteraction.hpp:58
CDPL::ForceField::MMFF94ElectrostaticInteraction::getAtom1Index
std::size_t getAtom1Index() const
Definition: MMFF94ElectrostaticInteraction.hpp:53
CDPL::ForceField::MMFF94ElectrostaticInteraction::MMFF94ElectrostaticInteraction
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)
Definition: MMFF94ElectrostaticInteraction.hpp:47
CDPL::ForceField::MMFF94ElectrostaticInteraction::getScalingFactor
double getScalingFactor() const
Definition: MMFF94ElectrostaticInteraction.hpp:73
CDPL
The namespace of the Chemical Data Processing Library.
CDPL_FORCEFIELD_API
#define CDPL_FORCEFIELD_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
CDPL::ForceField::MMFF94ElectrostaticInteraction::getAtom1Charge
double getAtom1Charge() const
Definition: MMFF94ElectrostaticInteraction.hpp:63
CDPL::ForceField::MMFF94ElectrostaticInteraction
Definition: MMFF94ElectrostaticInteraction.hpp:44