Skip to content

Commit 470ec80

Browse files
committed
refactor(potentials): Rename parameter 'k' to 'c' for clarity in precompute functions
1 parent 9ce2cde commit 470ec80

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

src/potentials/bonded/inversion.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ impl PlanarInversion {
4141
///
4242
/// # Input
4343
///
44-
/// - `k`: Force constant $C$.
44+
/// - `c`: Force constant $C$.
4545
///
4646
/// # Output
4747
///
@@ -52,8 +52,8 @@ impl PlanarInversion {
5252
///
5353
/// $$ C_{half} = C / 2 $$
5454
#[inline(always)]
55-
pub fn precompute<T: Real>(k: T) -> T {
56-
k * T::from(0.5)
55+
pub fn precompute<T: Real>(c: T) -> T {
56+
c * T::from(0.5)
5757
}
5858
}
5959

@@ -137,7 +137,7 @@ impl UmbrellaInversion {
137137
///
138138
/// # Input
139139
///
140-
/// - `k`: Force constant $C$.
140+
/// - `c`: Force constant $C$.
141141
/// - `psi0_deg`: Equilibrium out-of-plane angle $\psi_0$ in degrees.
142142
///
143143
/// # Output
@@ -150,9 +150,9 @@ impl UmbrellaInversion {
150150
///
151151
/// $$ C_{half} = C / 2, \quad \cos_{\psi,0} = \cos(\psi_0 \cdot \pi / 180) $$
152152
#[inline(always)]
153-
pub fn precompute<T: Real>(k: T, psi0_deg: T) -> (T, T) {
153+
pub fn precompute<T: Real>(c: T, psi0_deg: T) -> (T, T) {
154154
let deg_to_rad = T::pi() / T::from(180.0);
155-
let c_half = k * T::from(0.5);
155+
let c_half = c * T::from(0.5);
156156
let cos_psi0 = (psi0_deg * deg_to_rad).cos();
157157
(c_half, cos_psi0)
158158
}

0 commit comments

Comments
 (0)