File: Contrib.h

package info (click to toggle)
rdkit 202209.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 203,880 kB
  • sloc: cpp: 334,239; python: 80,247; ansic: 24,579; java: 7,667; sql: 2,123; yacc: 1,884; javascript: 1,358; lex: 1,260; makefile: 576; xml: 229; fortran: 183; cs: 181; sh: 101
file content (40 lines) | stat: -rw-r--r-- 1,116 bytes parent folder | download | duplicates (5)
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
//
//  Copyright (C) 2004-2006 Rational Discovery LLC
//
//   @@ All Rights Reserved @@
//  This file is part of the RDKit.
//  The contents are covered by the terms of the BSD license
//  which is included in the file license.txt, found at the root
//  of the RDKit source tree.
//
#include <RDGeneral/export.h>
#ifndef __RD_FFCONTRIB_H__
#define __RD_FFCONTRIB_H__

namespace ForceFields {
class ForceField;

//! abstract base class for contributions to ForceFields
class RDKIT_FORCEFIELD_EXPORT ForceFieldContrib {
 public:
  friend class ForceField;

  ForceFieldContrib() {}
  ForceFieldContrib(ForceFields::ForceField *owner) : dp_forceField(owner) {}
  virtual ~ForceFieldContrib() {}

  //! returns our contribution to the energy of a position
  virtual double getEnergy(double *pos) const = 0;

  //! calculates our contribution to the gradients of a position
  virtual void getGrad(double *pos, double *grad) const = 0;

  //! return a copy
  virtual ForceFieldContrib *copy() const = 0;

 protected:
  ForceField *dp_forceField{nullptr};  //!< our owning ForceField
};
}  // namespace ForceFields

#endif