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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! Bincode-based FFI API for physics sim Navier-Stokes functions.

use ndarray::Array2;
use serde::Serialize;

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::navier_stokes_fluid::NavierStokesParameters;
use crate::physics::physics_sim::navier_stokes_fluid::{
    self,
};

#[derive(Serialize)]
struct NavierStokesOutputData {
    pub u: Array2<f64>,
    pub v: Array2<f64>,
    pub p: Array2<f64>,
}

/// Solves the incompressible Navier-Stokes equations for fluid flow in a lid-driven cavity via bincode serialization.
///
/// The Navier-Stokes equations ∂u/∂t + (u·∇)u = -∇p/ρ + ν∇²u with incompressibility
/// constraint ∇·u = 0 govern viscous fluid dynamics. This solver uses a projection method
/// to enforce divergence-free velocity fields.
///
/// # Arguments
///
/// * `buffer` - A bincode-encoded buffer containing `NavierStokesParameters` with:
///   - `nx`, `ny`: Grid dimensions
///   - `re`: Reynolds number Re = UL/ν (ratio of inertial to viscous forces)
///   - `dt`: Time step size
///   - `n_iter`: Number of time iterations
///   - `lid_velocity`: Velocity of the moving lid boundary
///
/// # Returns
///
/// A bincode-encoded buffer containing `FfiResult<NavierStokesOutputData, String>` with either:
/// - `ok`: Object containing:
///   - `u`: Horizontal velocity field u(x,y)
///   - `v`: Vertical velocity field v(x,y)
///   - `p`: Pressure field p(x,y)
/// - `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_navier_stokes_run_bincode(
    buffer: BincodeBuffer
) -> BincodeBuffer {
    let params: NavierStokesParameters = match from_bincode_buffer(&buffer) {
        | Some(p) => p,
        | None => {
            return to_bincode_buffer(&FfiResult::<NavierStokesOutputData, String>::err(
                "Invalid Bincode".to_string(),
            ));
        },
    };

    match navier_stokes_fluid::run_lid_driven_cavity(&params) {
        | Ok((u, v, p)) => {
            let out = NavierStokesOutputData { u, v, p };

            to_bincode_buffer(&FfiResult::<NavierStokesOutputData, String>::ok(out))
        },
        | Err(e) => to_bincode_buffer(&FfiResult::<NavierStokesOutputData, String>::err(e)),
    }
}