oxiphysics-softbody 0.1.0

Soft body simulation for the OxiPhysics engine
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
// Copyright 2026 COOLJAPAN OU (Team KitaSan)
// SPDX-License-Identifier: Apache-2.0

//! Material models for FEM soft bodies: SoftMaterial, NeoHookean, HyperelasticBody.
//!
//! Uses raw f64 arrays (no nalgebra dependency).

#![allow(clippy::needless_range_loop)]

use super::math_helpers::{det3x3, edge_matrix_raw, inv3x3, mul3x3, transpose3x3};

// ---------------------------------------------------------------------------
// Standalone FEM types (f64 array-based, no nalgebra dependency)
// ---------------------------------------------------------------------------

/// Material properties for a soft body element.
#[derive(Debug, Clone, Copy)]
#[allow(dead_code)]
pub struct SoftMaterial {
    /// Young's modulus (stiffness).
    pub youngs_modulus: f64,
    /// Poisson's ratio (0..0.5).
    pub poisson_ratio: f64,
    /// Damping coefficient.
    pub damping: f64,
}

/// A corotational tetrahedral element using raw f64 arrays.
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct CorotationalElementRaw {
    /// Indices of the four nodes of the tetrahedron.
    pub node_indices: [usize; 4],
    /// Rest volume of the element.
    pub rest_volume: f64,
    /// Rest-shape edge matrix columns: `[e1, e2, e3]` where `ei = pi - p0`.
    pub rest_shape: [[f64; 3]; 3],
    /// Material properties.
    pub material: SoftMaterial,
}

#[allow(dead_code)]
impl CorotationalElementRaw {
    /// Create a new element from node positions.
    pub fn new(node_indices: [usize; 4], positions: &[[f64; 3]], material: SoftMaterial) -> Self {
        let p0 = positions[node_indices[0]];
        let p1 = positions[node_indices[1]];
        let p2 = positions[node_indices[2]];
        let p3 = positions[node_indices[3]];
        let e1 = [p1[0] - p0[0], p1[1] - p0[1], p1[2] - p0[2]];
        let e2 = [p2[0] - p0[0], p2[1] - p0[1], p2[2] - p0[2]];
        let e3 = [p3[0] - p0[0], p3[1] - p0[1], p3[2] - p0[2]];
        let det = e1[0] * (e2[1] * e3[2] - e2[2] * e3[1]) - e1[1] * (e2[0] * e3[2] - e2[2] * e3[0])
            + e1[2] * (e2[0] * e3[1] - e2[1] * e3[0]);
        let rest_volume = det.abs() / 6.0;
        Self {
            node_indices,
            rest_volume,
            rest_shape: [e1, e2, e3],
            material,
        }
    }

    /// Compute a 3x3 rotation matrix from the deformation gradient via
    /// iterative polar decomposition.
    pub fn compute_rotation(current_positions: &[[f64; 3]], indices: &[usize; 4]) -> [[f64; 3]; 3] {
        let p0 = current_positions[indices[0]];
        let p1 = current_positions[indices[1]];
        let p2 = current_positions[indices[2]];
        let p3 = current_positions[indices[3]];

        let ds = [
            [p1[0] - p0[0], p1[1] - p0[1], p1[2] - p0[2]],
            [p2[0] - p0[0], p2[1] - p0[1], p2[2] - p0[2]],
            [p3[0] - p0[0], p3[1] - p0[1], p3[2] - p0[2]],
        ];

        // Start with ds as initial guess for R.
        let mut r = ds;
        for _ in 0..10 {
            let det = r[0][0] * (r[1][1] * r[2][2] - r[1][2] * r[2][1])
                - r[0][1] * (r[1][0] * r[2][2] - r[1][2] * r[2][0])
                + r[0][2] * (r[1][0] * r[2][1] - r[1][1] * r[2][0]);
            if det.abs() < 1e-30 {
                return [[1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [0.0, 0.0, 1.0]];
            }
            let inv_det = 1.0 / det;
            let inv = [
                [
                    (r[1][1] * r[2][2] - r[1][2] * r[2][1]) * inv_det,
                    (r[0][2] * r[2][1] - r[0][1] * r[2][2]) * inv_det,
                    (r[0][1] * r[1][2] - r[0][2] * r[1][1]) * inv_det,
                ],
                [
                    (r[1][2] * r[2][0] - r[1][0] * r[2][2]) * inv_det,
                    (r[0][0] * r[2][2] - r[0][2] * r[2][0]) * inv_det,
                    (r[0][2] * r[1][0] - r[0][0] * r[1][2]) * inv_det,
                ],
                [
                    (r[1][0] * r[2][1] - r[1][1] * r[2][0]) * inv_det,
                    (r[0][1] * r[2][0] - r[0][0] * r[2][1]) * inv_det,
                    (r[0][0] * r[1][1] - r[0][1] * r[1][0]) * inv_det,
                ],
            ];
            // R = (R + inv^T) / 2
            for i in 0..3 {
                for j in 0..3 {
                    r[i][j] = (r[i][j] + inv[j][i]) * 0.5;
                }
            }
        }
        r
    }

    /// Compute elastic forces on the four nodes.
    pub fn compute_forces(&self, current_positions: &[[f64; 3]]) -> [[f64; 3]; 4] {
        let r = Self::compute_rotation(current_positions, &self.node_indices);
        // Simplified: force proportional to displacement from rest shape
        let p0 = current_positions[self.node_indices[0]];
        let mut forces = [[0.0; 3]; 4];
        let stiffness = self.material.youngs_modulus * self.rest_volume;

        for k in 1..4 {
            let pk = current_positions[self.node_indices[k]];
            let deformed = [pk[0] - p0[0], pk[1] - p0[1], pk[2] - p0[2]];
            // Rotated rest edge
            let rest_e = self.rest_shape[k - 1];
            let rotated = [
                r[0][0] * rest_e[0] + r[0][1] * rest_e[1] + r[0][2] * rest_e[2],
                r[1][0] * rest_e[0] + r[1][1] * rest_e[1] + r[1][2] * rest_e[2],
                r[2][0] * rest_e[0] + r[2][1] * rest_e[1] + r[2][2] * rest_e[2],
            ];
            let diff = [
                deformed[0] - rotated[0],
                deformed[1] - rotated[1],
                deformed[2] - rotated[2],
            ];
            let f = [
                -stiffness * diff[0],
                -stiffness * diff[1],
                -stiffness * diff[2],
            ];
            forces[k] = f;
            forces[0][0] -= f[0];
            forces[0][1] -= f[1];
            forces[0][2] -= f[2];
        }
        forces
    }
}

/// A FEM soft body using raw f64 arrays.
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct FemSoftBodyRaw {
    /// Node positions.
    pub nodes: Vec<[f64; 3]>,
    /// Node velocities.
    pub velocities: Vec<[f64; 3]>,
    /// Tetrahedral elements.
    pub elements: Vec<CorotationalElementRaw>,
    /// Mass per node.
    pub masses: Vec<f64>,
}

#[allow(dead_code)]
impl FemSoftBodyRaw {
    /// Create a new FEM soft body.
    pub fn new(nodes: Vec<[f64; 3]>, elements: Vec<CorotationalElementRaw>, mass: f64) -> Self {
        let n = nodes.len();
        Self {
            velocities: vec![[0.0; 3]; n],
            nodes,
            elements,
            masses: vec![mass; n],
        }
    }

    /// Perform one explicit Euler time step.
    pub fn step(&mut self, dt: f64, gravity: [f64; 3]) {
        let n = self.nodes.len();
        let mut forces = vec![[0.0f64; 3]; n];

        // Gravity
        for i in 0..n {
            forces[i][0] += self.masses[i] * gravity[0];
            forces[i][1] += self.masses[i] * gravity[1];
            forces[i][2] += self.masses[i] * gravity[2];
        }

        // Element forces
        for elem in &self.elements {
            let f = elem.compute_forces(&self.nodes);
            for k in 0..4 {
                let idx = elem.node_indices[k];
                forces[idx][0] += f[k][0];
                forces[idx][1] += f[k][1];
                forces[idx][2] += f[k][2];
            }
        }

        // Integrate
        for i in 0..n {
            let inv_m = 1.0 / self.masses[i];
            for d in 0..3 {
                self.velocities[i][d] += forces[i][d] * inv_m * dt;
                self.nodes[i][d] += self.velocities[i][d] * dt;
            }
        }
    }

    /// Total kinetic energy.
    pub fn kinetic_energy(&self) -> f64 {
        let mut ke = 0.0;
        for i in 0..self.nodes.len() {
            let v = self.velocities[i];
            ke += 0.5 * self.masses[i] * (v[0] * v[0] + v[1] * v[1] + v[2] * v[2]);
        }
        ke
    }

    /// Total gravitational potential energy.
    pub fn potential_energy(&self, gravity: [f64; 3]) -> f64 {
        let g_mag =
            (gravity[0] * gravity[0] + gravity[1] * gravity[1] + gravity[2] * gravity[2]).sqrt();
        if g_mag < 1e-30 {
            return 0.0;
        }
        let mut pe = 0.0;
        for i in 0..self.nodes.len() {
            let dot = self.nodes[i][0] * gravity[0]
                + self.nodes[i][1] * gravity[1]
                + self.nodes[i][2] * gravity[2];
            pe += -self.masses[i] * dot;
        }
        pe
    }
}

// ---------------------------------------------------------------------------
// Hyperelastic soft body (Neo-Hookean, raw f64)
// ---------------------------------------------------------------------------

/// Neo-Hookean hyperelastic material model.
///
/// Strain energy density: W = (mu/2)(I1 - 3) - mu ln(J) + (lambda/2)(ln J)^2
/// where I1 = tr(F^T F), J = det(F).
#[derive(Debug, Clone, Copy)]
#[allow(dead_code)]
pub struct NeoHookeanMaterial {
    /// First Lame parameter mu (shear modulus).
    pub mu: f64,
    /// Second Lame parameter lambda.
    pub lambda: f64,
}

#[allow(dead_code)]
impl NeoHookeanMaterial {
    /// Create from Young's modulus and Poisson's ratio.
    pub fn from_young_poisson(young: f64, poisson: f64) -> Self {
        let mu = young / (2.0 * (1.0 + poisson));
        let lambda = young * poisson / ((1.0 + poisson) * (1.0 - 2.0 * poisson));
        Self { mu, lambda }
    }

    /// Compute the first Piola-Kirchhoff stress tensor P = dW/dF.
    ///
    /// For Neo-Hookean: P = mu(F - F^{-T}) + lambda ln(J) F^{-T}
    ///
    /// Returns P as `[[P00,P01,P02\],[P10,P11,P12],[P20,P21,P22]]`.
    pub fn piola_kirchhoff(&self, deformation_gradient: [[f64; 3]; 3]) -> [[f64; 3]; 3] {
        let f = deformation_gradient;
        let det = det3x3(f);
        if det.abs() < 1e-30 {
            return [[0.0; 3]; 3];
        }
        let f_inv_t = super::math_helpers::inv3x3_transpose(f);
        let ln_j = det.abs().ln();

        let mut p = [[0.0_f64; 3]; 3];
        for i in 0..3 {
            for j in 0..3 {
                p[i][j] = self.mu * (f[i][j] - f_inv_t[i][j]) + self.lambda * ln_j * f_inv_t[i][j];
            }
        }
        p
    }

    /// Compute strain energy density W for a given deformation gradient.
    pub fn strain_energy(&self, f: [[f64; 3]; 3]) -> f64 {
        let det = det3x3(f);
        if det.abs() < 1e-30 {
            return 0.0;
        }
        // I1 = tr(F^T F)
        let mut i1 = 0.0;
        for i in 0..3 {
            for k in 0..3 {
                i1 += f[k][i] * f[k][i];
            }
        }
        let ln_j = det.abs().ln();
        0.5 * self.mu * (i1 - 3.0) - self.mu * ln_j + 0.5 * self.lambda * ln_j * ln_j
    }
}

/// A Neo-Hookean tetrahedral element using raw f64 arrays.
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct NeoHookeanElement {
    /// Indices of the four nodes.
    pub node_indices: [usize; 4],
    /// Rest-shape inverse of the edge matrix (Dm^{-1}).
    pub rest_inv: [[f64; 3]; 3],
    /// Rest volume.
    pub rest_volume: f64,
    /// Material.
    pub material: NeoHookeanMaterial,
}

#[allow(dead_code)]
impl NeoHookeanElement {
    /// Create a new element from node positions.
    pub fn new(
        node_indices: [usize; 4],
        positions: &[[f64; 3]],
        material: NeoHookeanMaterial,
    ) -> Self {
        let p0 = positions[node_indices[0]];
        let p1 = positions[node_indices[1]];
        let p2 = positions[node_indices[2]];
        let p3 = positions[node_indices[3]];
        let dm = edge_matrix_raw(p0, p1, p2, p3);
        let det = det3x3(dm);
        let rest_volume = det.abs() / 6.0;
        let rest_inv = inv3x3(dm);
        Self {
            node_indices,
            rest_inv,
            rest_volume,
            material,
        }
    }

    /// Compute the deformation gradient F = Ds * Dm^{-1}.
    pub fn deformation_gradient(&self, positions: &[[f64; 3]]) -> [[f64; 3]; 3] {
        let p0 = positions[self.node_indices[0]];
        let p1 = positions[self.node_indices[1]];
        let p2 = positions[self.node_indices[2]];
        let p3 = positions[self.node_indices[3]];
        let ds = edge_matrix_raw(p0, p1, p2, p3);
        mul3x3(ds, self.rest_inv)
    }

    /// Compute elastic forces on the four nodes.
    pub fn compute_forces(&self, positions: &[[f64; 3]]) -> [[f64; 3]; 4] {
        let f = self.deformation_gradient(positions);
        let p = self.material.piola_kirchhoff(f);
        // H = -V * P * Dm^{-T}
        let dm_inv_t = transpose3x3(self.rest_inv);
        let h = mul3x3(p, dm_inv_t);

        let mut forces = [[0.0; 3]; 4];
        for i in 0..3 {
            forces[1][i] = -self.rest_volume * h[i][0];
            forces[2][i] = -self.rest_volume * h[i][1];
            forces[3][i] = -self.rest_volume * h[i][2];
            forces[0][i] = -(forces[1][i] + forces[2][i] + forces[3][i]);
        }
        forces
    }

    /// Compute the strain energy of this element.
    pub fn strain_energy(&self, positions: &[[f64; 3]]) -> f64 {
        let f = self.deformation_gradient(positions);
        self.rest_volume * self.material.strain_energy(f)
    }
}

/// A hyperelastic FEM body using Neo-Hookean elements.
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct HyperelasticBody {
    /// Node positions.
    pub nodes: Vec<[f64; 3]>,
    /// Node velocities.
    pub velocities: Vec<[f64; 3]>,
    /// Elements.
    pub elements: Vec<NeoHookeanElement>,
    /// Mass per node.
    pub masses: Vec<f64>,
    /// Damping coefficient.
    pub damping: f64,
}

#[allow(dead_code)]
impl HyperelasticBody {
    /// Create a new hyperelastic body.
    pub fn new(
        nodes: Vec<[f64; 3]>,
        elements: Vec<NeoHookeanElement>,
        mass: f64,
        damping: f64,
    ) -> Self {
        let n = nodes.len();
        Self {
            velocities: vec![[0.0; 3]; n],
            nodes,
            elements,
            masses: vec![mass; n],
            damping,
        }
    }

    /// Perform one explicit Euler time step.
    pub fn step(&mut self, dt: f64, gravity: [f64; 3]) {
        let n = self.nodes.len();
        let mut forces = vec![[0.0f64; 3]; n];

        for i in 0..n {
            for d in 0..3 {
                forces[i][d] += self.masses[i] * gravity[d];
            }
        }

        for elem in &self.elements {
            let f = elem.compute_forces(&self.nodes);
            for k in 0..4 {
                let idx = elem.node_indices[k];
                for d in 0..3 {
                    forces[idx][d] += f[k][d];
                }
            }
        }

        for i in 0..n {
            let inv_m = 1.0 / self.masses[i];
            for d in 0..3 {
                self.velocities[i][d] += forces[i][d] * inv_m * dt;
                self.velocities[i][d] *= 1.0 - self.damping;
                self.nodes[i][d] += self.velocities[i][d] * dt;
            }
        }
    }

    /// Total kinetic energy.
    pub fn kinetic_energy(&self) -> f64 {
        let mut ke = 0.0;
        for i in 0..self.nodes.len() {
            let v = self.velocities[i];
            ke += 0.5 * self.masses[i] * (v[0] * v[0] + v[1] * v[1] + v[2] * v[2]);
        }
        ke
    }

    /// Total strain energy.
    pub fn strain_energy(&self) -> f64 {
        self.elements
            .iter()
            .map(|e| e.strain_energy(&self.nodes))
            .sum()
    }
}