Image dependent pair potential#
- class autode.neb.idpp.IDPP(n_images: int, k_spr: float = 1.0, sequential: bool = True, rms_gtol: float = 0.001, maxiter: int = 1000, add_img_maxgtol: float = 0.002, add_img_maxiter: int = 200)#
Image dependent pair potential (IDPP) objective function from https://arxiv.org/pdf/1406.1512.pdf
\[S = Σ_i Σ_{j>i} w(r_{ij}) (r_{ij}^{(k)} - r_{ij})^2\]where \(r_{ij}\) is the distance between atoms i and j and \(r_{ij}^{(k)} = r_{ij}^{(1)} + k(r_{ij}^{(N)} - r_{ij}^{(1)})/N\) for \(N\) images. The weight function is \(w(r_{ij}) = r_{ij}^{-4}\), as suggested in the paper. Computation is done in C++ extension
- __init__(n_images: int, k_spr: float = 1.0, sequential: bool = True, rms_gtol: float = 0.001, maxiter: int = 1000, add_img_maxgtol: float = 0.002, add_img_maxiter: int = 200)#
Initialise an IDPP calculation
- Parameters:
n_images – Number of images requested
k_spr – The spring constant
sequential – Whether to use sequential IDPP
rms_gtol – RMS gradient tolerance for path
maxiter – Maximum number of iterations for path
add_img_maxgtol – Maximum gradient tolerance for adding images
add_img_maxiter – Maximum number of iterations for adding image
- get_path(init_coords: ndarray, final_coords: ndarray) ndarray#
Get the IDPP path between the intial and final coordinates
- Parameters:
init_coords – Numpy array of initial coordinates
final_coords – Numpy array of final coordinates
- Returns:
- Numpy array of coordinates of the
intermediate images in the path
- Return type:
(np.ndarray)
- get_path_length(init_coords: ndarray, final_coords: ndarray) float#
Get the length of the IDPP path between the intial and final coordinates
- Parameters:
init_coords – Numpy array of initial coordinates
final_coords – Numpy array of final coordinates
- Returns:
Length of the IDPP path
- Return type:
(float)
- relax_path(coords_list: List[ndarray]) List[ndarray]#
Relax the set of coordinates using the IDPP method
- Parameters:
coords_list – List of coordinates (numpy arrays)
- Returns:
List of relaxed coordinates
- Return type:
(List[np.ndarray])