RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
RDMIF::Coulomb Class Reference

class for calculation of electrostatic interaction (Coulomb energy) between probe and molecule in vacuum (no dielectric) More...

#include <MIFDescriptors.h>

Public Member Functions

 Coulomb ()=default
 
 ~Coulomb ()=default
 
 Coulomb (const std::vector< double > &charges, const std::vector< RDGeom::Point3D > &positions, double probeCharge=1.0, bool absVal=false, double alpha=0.0, double cutoff=1.0)
 constructs Coulomb object from vectors of charges and positions
 
 Coulomb (const RDKit::ROMol &mol, int confId=-1, double probeCharge=1.0, bool absVal=false, const std::string &prop="_GasteigerCharge", double alpha=0.0, double cutoff=1.0)
 constructs Coulomb object from a molecule object
 
double operator() (double x, double y, double z, double thres) const
 calculated the electrostatic interaction at point pt in the molecules field in [kJ mol^-1]
 

Detailed Description

class for calculation of electrostatic interaction (Coulomb energy) between probe and molecule in vacuum (no dielectric)

Definition at line 110 of file MIFDescriptors.h.

Constructor & Destructor Documentation

◆ Coulomb() [1/3]

RDMIF::Coulomb::Coulomb ( )
default

◆ ~Coulomb()

RDMIF::Coulomb::~Coulomb ( )
default

◆ Coulomb() [2/3]

RDMIF::Coulomb::Coulomb ( const std::vector< double > &  charges,
const std::vector< RDGeom::Point3D > &  positions,
double  probeCharge = 1.0,
bool  absVal = false,
double  alpha = 0.0,
double  cutoff = 1.0 
)

constructs Coulomb object from vectors of charges and positions

Parameters
chargesvector of charges [e]
posvector of postions [A]
probeChargecharge of probe [e] (default: 1.0)
absValif true, negative (favored) values of interactions are calculated (default: false)
alphasoftcore interaction parameter [A^2]; if zero, a minimum cutoff distance is used (default: 0.0)
cutoffminimum cutoff distance [A] (default: 1.0)

◆ Coulomb() [3/3]

RDMIF::Coulomb::Coulomb ( const RDKit::ROMol mol,
int  confId = -1,
double  probeCharge = 1.0,
bool  absVal = false,
const std::string &  prop = "_GasteigerCharge",
double  alpha = 0.0,
double  cutoff = 1.0 
)

constructs Coulomb object from a molecule object

The molecule mol needs to have partial charges set as property of atoms.

Parameters
molmolecule object
confIdconformation id which is used to get positions of atoms (default=-1)
absValif true, absolute values of interactions are calculated (default: false)
probeChargecharge of probe [e] (default: 1.0)
propproperty key for retrieving partial charges of atoms (default: "_GasteigerCharge")
alphasoftcore interaction parameter [A^2], if zero, a minimum cutoff distance is used (default: 0.0)
cutoffminimum cutoff distance [A] (default: 1.0)

Member Function Documentation

◆ operator()()

double RDMIF::Coulomb::operator() ( double  x,
double  y,
double  z,
double  thres 
) const

calculated the electrostatic interaction at point pt in the molecules field in [kJ mol^-1]

Parameters
x,y,zcoordinates at which the interaction is calculated
thressquared max distance until interactions are calc.
Returns
electrostatic interaction energy in [kJ mol^-1]

The documentation for this class was generated from the following file: