Skip to content

Commit f63c8e6

Browse files
committed
docs(potentials): Update module documentation for molecular mechanics potential energy functions
1 parent 3c9b17f commit f63c8e6

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

src/potentials/mod.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1+
//! Molecular mechanics potential energy functions.
2+
//!
3+
//! This module organizes the physical interaction kernels used in the DREIDING force field.
4+
//! These kernels are pure functions that compute potential energy and force derivatives
5+
//! based on geometric parameters (distances, angles) and force field constants.
6+
//!
7+
//! # Categories
8+
//!
9+
//! - [`bonded`]: Intramolecular interactions (covalent bonds, angles, dihedrals).
10+
//! - [`nonbonded`]: Intermolecular and non-bonded intramolecular interactions (VDW, Electrostatics).
11+
112
pub mod bonded;
213
pub mod nonbonded;

0 commit comments

Comments
 (0)