rssn 0.2.9

A comprehensive scientific computing library for Rust, aiming for feature parity with NumPy and SymPy.
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

//! Bincode-based FFI API for physics sim linear elasticity functions.

use crate::ffi_apis::common::BincodeBuffer;
use crate::ffi_apis::common::from_bincode_buffer;
use crate::ffi_apis::common::to_bincode_buffer;
use crate::ffi_apis::ffi_api::FfiResult;
use crate::physics::physics_sim::linear_elasticity::ElasticityParameters;
use crate::physics::physics_sim::linear_elasticity::{
    self,
};

/// Solves the linear elasticity equations for stress and displacement in a deformable solid via bincode serialization.
///
/// The elasticity equations σᵢⱼ = Cᵢⱼₖₗεₖₗ with strain εᵢⱼ = ½(∂uᵢ/∂xⱼ + ∂uⱼ/∂xᵢ) describe
/// small deformations in elastic materials, where σ is stress tensor, ε is strain tensor,
/// u is displacement field, and C is the stiffness tensor.
///
/// # Arguments
///
/// * `buffer` - A bincode-encoded buffer containing `ElasticityParameters` with:
///   - `nx`, `ny`: Grid dimensions for finite element discretization
///   - `young_modulus`: Young's modulus E (stiffness)
///   - `poisson_ratio`: Poisson's ratio ν (lateral contraction)
///   - `applied_force`: External force distribution
///   - `boundary_conditions`: Fixed displacement constraints
///
/// # Returns
///
/// A bincode-encoded buffer containing `FfiResult<Vec<f64>, String>` with either:
/// - `ok`: Displacement field u(x,y) as flattened vector
/// - `err`: Error message if computation failed
///
/// # Safety
///
/// This function is unsafe because it receives a raw bincode buffer that must be
/// valid and properly encoded.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_physics_sim_linear_elasticity_run_bincode(
    buffer: BincodeBuffer
) -> BincodeBuffer {
    let params: ElasticityParameters = match from_bincode_buffer(&buffer) {
        | Some(p) => p,
        | None => {
            return to_bincode_buffer(&FfiResult::<Vec<f64>, String>::err(
                "Invalid Bincode".to_string(),
            ));
        },
    };

    match linear_elasticity::run_elasticity_simulation(&params) {
        | Ok(res) => to_bincode_buffer(&FfiResult::<Vec<f64>, String>::ok(res)),
        | Err(e) => to_bincode_buffer(&FfiResult::<Vec<f64>, String>::err(e)),
    }
}