Chemical Data Processing Library C++ API - Version 1.4.0
TorsionDriverSettings.hpp
Go to the documentation of this file.
1 /*
2  * TorsionDriverSettings.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_CONFGEN_TORSIONDRIVERSETTINGS_HPP
30 #define CDPL_CONFGEN_TORSIONDRIVERSETTINGS_HPP
31 
32 #include <cstddef>
33 
35 
36 
37 namespace CDPL
38 {
39 
40  namespace ConfGen
41  {
42 
47  {
48 
49  public:
52 
57 
62  void sampleHeteroAtomHydrogens(bool sample);
63 
69 
74  void sampleAngleToleranceRanges(bool sample);
75 
81 
86  void orderByEnergy(bool order);
87 
92  bool orderByEnergy() const;
93 
98  void setEnergyWindow(double win_size);
99 
104  double getEnergyWindow() const;
105 
110  void setMaxPoolSize(std::size_t max_size);
111 
116  std::size_t getMaxPoolSize() const;
117 
122  void setForceFieldType(unsigned int type);
123 
128  unsigned int getForceFieldType() const;
129 
136 
142 
147  void setDielectricConstant(double de_const);
148 
153  double getDielectricConstant() const;
154 
159  void setDistanceExponent(double exponent);
160 
165  double getDistanceExponent() const;
166 
167  private:
168  bool sampleHetAtomHs;
169  bool sampleTolRanges;
170  bool energyOrdered;
171  double eWindow;
172  std::size_t maxPoolSize;
173  unsigned int forceFieldType;
174  bool strictParam;
175  double dielectricConst;
176  double distExponent;
177  };
178  } // namespace ConfGen
179 } // namespace CDPL
180 
181 #endif // CDPL_CONFGEN_TORSIONDRIVERSETTINGS_HPP
Definition of the preprocessor macro CDPL_CONFGEN_API.
#define CDPL_CONFGEN_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Bundle of configuration parameters for systematic conformer enumeration via class ConfGen::TorsionDri...
Definition: TorsionDriverSettings.hpp:47
double getDistanceExponent() const
Returns the exponent of the MMFF94 distance-dependent electrostatic term.
void sampleAngleToleranceRanges(bool sample)
Specifies whether additional torsion samples within the tolerance ranges defined by the torsion libra...
void setDistanceExponent(double exponent)
Sets the exponent of the MMFF94 distance-dependent electrostatic term.
static const TorsionDriverSettings DEFAULT
A static instance providing configuration parameter default values.
Definition: TorsionDriverSettings.hpp:51
void sampleHeteroAtomHydrogens(bool sample)
Specifies whether torsions of heteroatom hydrogen rotors shall be sampled.
std::size_t getMaxPoolSize() const
Returns the maximum number of conformers kept in the internal candidate pool.
void strictForceFieldParameterization(bool strict)
Specifies whether strict MMFF94 parameterization is required.
void setMaxPoolSize(std::size_t max_size)
Sets the maximum number of conformers to keep in the internal candidate pool.
void setDielectricConstant(double de_const)
Sets the dielectric constant used by the MMFF94 electrostatic interactions.
bool sampleHeteroAtomHydrogens() const
Tells whether torsions of heteroatom hydrogen rotors are sampled.
TorsionDriverSettings()
Constructs the TorsionDriverSettings instance with default configuration parameter values.
unsigned int getForceFieldType() const
Returns the force field type used to score the generated conformers.
bool strictForceFieldParameterization() const
Tells whether strict MMFF94 parameterization is required.
double getEnergyWindow() const
Returns the configured energy window size.
void orderByEnergy(bool order)
Specifies whether the generated conformers shall be sorted by ascending energy.
void setEnergyWindow(double win_size)
Sets the energy window size (in kcal/mol) above the found global minimum within which conformers are ...
void setForceFieldType(unsigned int type)
Sets the force field type used to score the generated conformers.
bool sampleAngleToleranceRanges() const
Tells whether tolerance-range sampling is enabled.
bool orderByEnergy() const
Tells whether the generated conformers are sorted by ascending energy.
double getDielectricConstant() const
Returns the dielectric constant used by the MMFF94 electrostatic interactions.
The namespace of the Chemical Data Processing Library.