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

//! Handle-based FFI API for physics FVM functions.

use std::ptr;

use crate::physics::physics_fvm::Mesh;
use crate::physics::physics_fvm::{
    self,
};

/// Creates a new Mesh handle.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_physics_fvm_mesh_new(
    num_cells: usize,
    domain_size: f64,
) -> *mut Mesh {
    Box::into_raw(Box::new(Mesh::new(num_cells, domain_size, |_| 0.0)))
}

/// Frees a Mesh handle.
///
/// # 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_fvm_mesh_free(mesh: *mut Mesh) {
    unsafe {
        if !mesh.is_null() {
            let _ = Box::from_raw(mesh);
        }
    }
}

/// Returns a pointer to the mesh data.
///
/// # 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_fvm_mesh_data(mesh: *mut Mesh) -> *mut f64 {
    unsafe {
        if mesh.is_null() {
            return ptr::null_mut();
        }

        (*mesh).cells.as_mut_ptr().cast::<f64>()
    }
}

/// Simulates 1D advection and returns the final values in a new buffer.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_physics_fvm_simulate_advection_1d() -> *mut f64 {
    let result = physics_fvm::simulate_1d_advection_scenario();

    let mut result = result.into_boxed_slice();

    let ptr = result.as_mut_ptr();

    std::mem::forget(result);

    ptr
}