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 MM functions.

use serde::Deserialize;

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_mm::SPHSystem;

#[derive(Deserialize)]
struct SphInput {
    system: SPHSystem,
    dt: f64,
}

/// Updates a Smoothed Particle Hydrodynamics (SPH) system by one time step via bincode serialization.
///
/// SPH is a meshfree Lagrangian method for simulating fluid dynamics by representing
/// the continuum as a set of particles with smoothed properties.
///
/// # Arguments
///
/// * `buffer` - A bincode-encoded buffer containing `SphInput` with:
///   - `system`: SPH system state (particles with positions, velocities, densities, etc.)
///   - `dt`: Time step size
///
/// # Returns
///
/// A bincode-encoded buffer containing `FfiResult<SPHSystem, String>` with either:
/// - `ok`: Updated SPH system state after time step
/// - `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_mm_sph_update_bincode(
    buffer: BincodeBuffer
) -> BincodeBuffer {
    let mut input: SphInput = match from_bincode_buffer(&buffer) {
        | Some(i) => i,
        | None => {
            return to_bincode_buffer(&FfiResult::<SPHSystem, String>::err(
                "Invalid Bincode".to_string(),
            ));
        },
    };

    input.system.update(input.dt);

    to_bincode_buffer(&FfiResult::<SPHSystem, String>::ok(input.system))
}