pele.potentials.BasePotential

class pele.potentials.BasePotential[source]

Base class for all potentials

Derived classes must overload getEnergy(). It is also highly recommended to overload getEnergyGradient(), otherwise gradients will be calculated numerically

getEnergyGradient()

Methods

NumericalDerivative(coords[, eps]) return the gradient calculated numerically
NumericalHessian(coords[, eps]) return the Hessian matrix of second derivatives computed numerically
getEnergy(coords) return the energy at the given coordinates
getEnergyGradient(coords) return the energy and gradient at the given coordinates
getEnergyGradientHessian(coords) return the energy, gradient, and Hessian at the given coordinates
getEnergyGradientNumerical(coords)
getGradient(coords) return the gradient at the given coordinates
getHessian(coords) return the hessian
test_potential(coords[, eps]) print some information testing whether the analytical gradients are correct

Previous topic

pele.potentials.GMINPotential.test_potential

Next topic

pele.potentials.BasePotential.NumericalDerivative