nvalchemi.dynamics.mep.SpringContext#

class nvalchemi.dynamics.mep.SpringContext(energies, positions, physical_forces, image_ptr, layout, cell, pbc, step_count)[source]#

Read-only inputs available to spring-constant policies.

Tensor fields share storage with the active NEB state and must not be modified in-place by implementations.

Parameters:
  • energies (Tensor or None) – Flattened physical image energies, shape (num_images,). None before the first model evaluation.

  • positions (Tensor) – Packed atomic positions, shape (num_atoms, 3).

  • physical_forces (Tensor or None) – Packed physical model forces, shape (num_atoms, 3). None before the first model evaluation.

  • image_ptr (Tensor) – Atom offsets delimiting packed images, shape (num_images + 1,).

  • layout (GroupLayout) – Mapping from packed images to NEB paths.

  • cell (Tensor) – Representative cell for each path, shape (num_paths, 3, 3).

  • pbc (Tensor) – Periodic-boundary flags for each path, shape (num_paths, 3).

  • step_count (int) – Current dynamics step.

Return the number of adjacent image pairs across all paths.