File: FourthDimContrib.h

package info (click to toggle)
rdkit 201203-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 37,840 kB
  • sloc: cpp: 93,902; python: 51,897; java: 5,192; ansic: 3,497; xml: 2,499; sql: 1,641; yacc: 1,518; lex: 1,076; makefile: 325; fortran: 183; sh: 153; cs: 51
file content (56 lines) | stat: -rw-r--r-- 1,870 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
//
// Created by Santosh Putta, Nov 2006
//
#ifndef __RD_FOURTHDIMCONTRIB_H__
#define __RD_FOURTHDIMCONTRIB_H__

#include <RDGeneral/Invariant.h>
#include <ForceField/Contrib.h>
#include <ForceField/ForceField.h>

namespace DistGeom {
  //! A term used in penalizing chirality violations
  //!
  class FourthDimContrib : public ForceFields::ForceFieldContrib {
  public:
    FourthDimContrib() : d_idx(0), d_weight(0.0) {};

    //! Constructor
    /*!
      \param owner       pointer to the owning ForceField
      \param idx        the index of the atom to be considered
      \param weight     (optional) the weight to be used for this contrib
                        
    */
    FourthDimContrib(ForceFields::ForceField *owner,unsigned int idx,
                     double weight) : d_idx(idx), d_weight(weight) {
      PRECONDITION(owner,"bad force field");
      PRECONDITION(owner->dimension()==4,"force field has wrong dimension");
      dp_forceField=owner;
    };

    //! return the contribution of this contrib to the energy of a given state 
    double getEnergy(double *pos) const {
      PRECONDITION(dp_forceField,"no owner");
      PRECONDITION(dp_forceField->dimension()==4,"force field has wrong dimension");
      PRECONDITION(pos,"bad vector");
      unsigned int pid = d_idx*dp_forceField->dimension() + 3;
      return d_weight*pos[pid]*pos[pid];
    }
    
    //! calculate the contribution of this contrib to the gradient at a given state
    void getGrad(double *pos, double *grad) const {
      PRECONDITION(dp_forceField,"no owner");
      PRECONDITION(dp_forceField->dimension()==4,"force field has wrong dimension");
      PRECONDITION(pos,"bad vector");
      unsigned int pid = d_idx*dp_forceField->dimension() + 3;
      grad[pid] += d_weight*pos[pid];
    }
  private:
    unsigned int d_idx;
    double d_weight;
  };
}

#endif