Chemical Data Processing Library C++ API - Version 1.4.0
MMFF94ElectrostaticInteractionParameterizer.hpp
Go to the documentation of this file.
1 /*
2  * MMFF94ElectrostaticInteractionParameterizer.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_MMFF94ELECTROSTATICINTERACTIONPARAMETERIZER_HPP
30 #define CDPL_FORCEFIELD_MMFF94ELECTROSTATICINTERACTIONPARAMETERIZER_HPP
31 
32 #include <memory>
33 
39 
40 
41 namespace CDPL
42 {
43 
44  namespace Chem
45  {
46 
47  class MolecularGraph;
48  }
49 
50  namespace ForceField
51  {
52 
61  {
62 
63  public:
65  static constexpr double DEF_DISTANCE_EXPONENT = 1.0;
67  static constexpr double DEF_DIELECTRIC_CONSTANT = 1.0;
69  static constexpr double DIELECTRIC_CONSTANT_WATER = 80.0;
70 
72  typedef std::shared_ptr<MMFF94ElectrostaticInteractionParameterizer> SharedPointer;
73 
78 
88  bool strict);
89 
95 
101 
107 
112  void setDielectricConstant(double de_const);
113 
118  void setDistanceExponent(double dist_expo);
119 
128  void parameterize(const Chem::MolecularGraph& molgraph, MMFF94ElectrostaticInteractionList& ia_list, bool strict);
129 
130  private:
131  InteractionFilterFunction2 filterFunc;
132  MMFF94AtomChargeFunction chargeFunc;
134  double deConst;
135  double distExpo;
136  };
137  } // namespace ForceField
138 } // namespace CDPL
139 
140 #endif // CDPL_FORCEFIELD_MMFF94ELECTROSTATICINTERACTIONPARAMETERIZER_HPP
Definition of the preprocessor macro CDPL_FORCEFIELD_API.
#define CDPL_FORCEFIELD_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Type declaration of generic wrapper class types for storing user-defined interaction filtering predic...
Declaration of type CDPL::ForceField::MMFF94ElectrostaticInteractionList.
Type declaration of generic wrapper classes for storing user-defined functions for the retrieval of M...
Type definition of generic wrapper class for storing an user-defined topological atom-pair distance f...
Abstract base class for representations of a chemical structure as a graph of bonded atoms.
Definition: MolecularGraph.hpp:57
Detects and parameterizes the MMFF94 electrostatic interactions of a molecular graph.
Definition: MMFF94ElectrostaticInteractionParameterizer.hpp:61
void setDistanceExponent(double dist_expo)
Sets the exponent of the MMFF94 distance-dependent electrostatic potential.
void setDielectricConstant(double de_const)
Sets the dielectric constant used by the MMFF94 electrostatic potential.
void parameterize(const Chem::MolecularGraph &molgraph, MMFF94ElectrostaticInteractionList &ia_list, bool strict)
Perceives the MMFF94 electrostatic interactions for molgraph and outputs the corresponding parameter ...
MMFF94ElectrostaticInteractionParameterizer(const Chem::MolecularGraph &molgraph, MMFF94ElectrostaticInteractionList &ia_list, bool strict)
Constructs the parameterizer and processes the molecular graph molgraph.
void setFilterFunction(const InteractionFilterFunction2 &func)
Sets the filter function used to skip atom pairs during parameterization.
std::shared_ptr< MMFF94ElectrostaticInteractionParameterizer > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated MMFF94ElectrostaticInteractionPar...
Definition: MMFF94ElectrostaticInteractionParameterizer.hpp:72
void setTopologicalDistanceFunction(const TopologicalAtomDistanceFunction &func)
Sets the function used to determine the topological distance between two atoms (number of bonds along...
MMFF94ElectrostaticInteractionParameterizer()
Constructs an MMFF94ElectrostaticInteractionParameterizer instance with default settings.
void setAtomChargeFunction(const MMFF94AtomChargeFunction &func)
Sets the function used to look up the MMFF94 partial charge of an atom.
std::function< std::size_t(const Chem::Atom &, const Chem::Atom &, const Chem::MolecularGraph &)> TopologicalAtomDistanceFunction
Generic wrapper class used to store a user-defined topological atom-pair distance function.
Definition: TopologicalAtomDistanceFunction.hpp:53
std::function< double(const Chem::Atom &)> MMFF94AtomChargeFunction
Generic wrapper class used to store a user-defined MMFF94 partial atom charge function.
Definition: MMFF94PropertyFunctions.hpp:66
std::function< bool(const Chem::Atom &, const Chem::Atom &)> InteractionFilterFunction2
Generic wrapper for storing user-defined two-atom interaction filtering functions (see [FUNWRP]).
Definition: InteractionFilterFunctions.hpp:54
The namespace of the Chemical Data Processing Library.