OneCAD-Simulation/crates/lbm/tests/common/mod.rs

//! Shared helpers for the lattice Boltzmann tests: models, analytic shapes generated in code, and
//! running a flow to a time.
#![allow(dead_code)]

use std::collections::BTreeMap;

use fieldcraft_lbm::{Flow, Limits, Obstacle, Setup};
use fieldcraft_mesh::surface::{BoundarySurface, SurfaceOptions};
use fieldcraft_model::{BoxFaces, Fluid, FluidDomain, Material, Model, Procedure, Step};

/// A domain over [min, max] with walls on every face.
pub fn domain(min: [f64; 3], max: [f64; 3], spacing: f64) -> FluidDomain {
    FluidDomain {
        material: "Fluid".into(),
        min,
        max,
        spacing,
        faces: BoxFaces::default(),
        obstacles: vec![],
        surfaces: vec![],
        initial_velocity: [0.0; 3],
        acceleration: [0.0; 3],
        tolerance: None,
    }
}

/// A fluid step `Run` over `end_time` with a given time step.
pub fn step(end_time: f64, time_step: f64, magic: Option<f64>) -> Procedure {
    Procedure::Fluid { domain: "Flow".into(), end_time: Some(end_time), steps: None, time_step: Some(time_step), frames: 2, magic }
}

/// A model with fluid `Fluid` (density ρ, kinematic viscosity ν), domain `Flow` and step `Run`.
pub fn model(density: f64, nu: f64, domain: FluidDomain, procedure: Procedure) -> Model {
    let mut m = Model::default();
    m.add_material("Fluid", Material { density: Some(density), fluid: Some(Fluid::Newtonian { viscosity: nu * density }), ..Material::default() })
        .unwrap();
    m.add_fluid_domain("Flow", domain).unwrap();
    m.add_step(Step::new("Run", procedure), None).unwrap();
    m
}

/// The setup and the flow at its initial state.
pub fn prepare(m: &Model, obstacles: &[Obstacle]) -> (Setup, Flow) {
    let setup = Setup::new(m, None, obstacles, &Limits::default()).unwrap();
    let flow = Flow::new(&setup, obstacles).unwrap();
    (setup, flow)
}

/// Run every step of the setup.
pub fn run_all(setup: &Setup, flow: &mut Flow) {
    for _ in 0..setup.steps {
        flow.step().unwrap();
    }
}

/// The convergence order of errors at resolutions growing by `ratio` each.
pub fn orders(errors: &[f64], ratio: f64) -> Vec<f64> {
    errors.windows(2).map(|w| (w[0] / w[1]).ln() / ratio.ln()).collect()
}

/// A closed surface from triangles, each turned to face `outward(centroid)`.
pub fn surface(
    positions: Vec<[f64; 3]>,
    mut triangles: Vec<[u32; 3]>,
    tags: Vec<u32>,
    outward: impl Fn([f64; 3], u32) -> [f64; 3],
) -> BoundarySurface {
    for (t, tag) in triangles.iter_mut().zip(&tags) {
        let [a, b, c] = t.map(|v| positions[v as usize]);
        let (u, v) = ([b[0] - a[0], b[1] - a[1], b[2] - a[2]], [c[0] - a[0], c[1] - a[1], c[2] - a[2]]);
        let n = [u[1] * v[2] - u[2] * v[1], u[2] * v[0] - u[0] * v[2], u[0] * v[1] - u[1] * v[0]];
        let centroid = [0, 1, 2].map(|k| (a[k] + b[k] + c[k]) / 3.0);
        let o = outward(centroid, *tag);
        if n[0] * o[0] + n[1] * o[1] + n[2] * o[2] < 0.0 {
            t.swap(1, 2);
        }
    }
    BoundarySurface::new(&positions, &triangles, &tags, &SurfaceOptions::default()).unwrap()
}

/// A sphere of radius `r` about `centre`: an icosahedron subdivided `levels` times, one face.
pub fn sphere(centre: [f64; 3], r: f64, levels: u32) -> BoundarySurface {
    let t = (1.0 + 5f64.sqrt()) / 2.0;
    let mut unit: Vec<[f64; 3]> = vec![
        [-1.0, t, 0.0],
        [1.0, t, 0.0],
        [-1.0, -t, 0.0],
        [1.0, -t, 0.0],
        [0.0, -1.0, t],
        [0.0, 1.0, t],
        [0.0, -1.0, -t],
        [0.0, 1.0, -t],
        [t, 0.0, -1.0],
        [t, 0.0, 1.0],
        [-t, 0.0, -1.0],
        [-t, 0.0, 1.0],
    ];
    let normalise = |p: [f64; 3]| {
        let l = (p[0] * p[0] + p[1] * p[1] + p[2] * p[2]).sqrt();
        p.map(|c| c / l)
    };
    unit = unit.into_iter().map(normalise).collect();
    let mut tris: Vec<[u32; 3]> = vec![
        [0, 11, 5],
        [0, 5, 1],
        [0, 1, 7],
        [0, 7, 10],
        [0, 10, 11],
        [1, 5, 9],
        [5, 11, 4],
        [11, 10, 2],
        [10, 7, 6],
        [7, 1, 8],
        [3, 9, 4],
        [3, 4, 2],
        [3, 2, 6],
        [3, 6, 8],
        [3, 8, 9],
        [4, 9, 5],
        [2, 4, 11],
        [6, 2, 10],
        [8, 6, 7],
        [9, 8, 1],
    ];
    for _ in 0..levels {
        let mut mid: BTreeMap<(u32, u32), u32> = BTreeMap::new();
        let mut next = Vec::with_capacity(tris.len() * 4);
        for [a, b, c] in tris {
            let mut m = |p: u32, q: u32| {
                *mid.entry((p.min(q), p.max(q))).or_insert_with(|| {
                    let (x, y) = (unit[p as usize], unit[q as usize]);
                    unit.push(normalise([(x[0] + y[0]) / 2.0, (x[1] + y[1]) / 2.0, (x[2] + y[2]) / 2.0]));
                    (unit.len() - 1) as u32
                })
            };
            let (ab, bc, ca) = (m(a, b), m(b, c), m(c, a));
            next.extend([[a, ab, ca], [b, bc, ab], [c, ca, bc], [ab, bc, ca]]);
        }
        tris = next;
    }
    let positions: Vec<[f64; 3]> = unit.iter().map(|p| [centre[0] + r * p[0], centre[1] + r * p[1], centre[2] + r * p[2]]).collect();
    let tags = vec![0; tris.len()];
    surface(positions, tris, tags, |p, _| [p[0] - centre[0], p[1] - centre[1], p[2] - centre[2]])
}

/// A tube along x from `x0` to `x1` about the axis through (`y`, `z`): inner radius `r`, outer
/// radius `outer`, `m` segments. Faces: 0 inner wall, 1 outer wall, 2 and 3 the ends.
pub fn tube(x0: f64, x1: f64, axis: [f64; 2], r: f64, outer: f64, m: usize) -> BoundarySurface {
    let mut positions = Vec::new();
    for x in [x0, x1] {
        for radius in [r, outer] {
            for k in 0..m {
                let phi = 2.0 * std::f64::consts::PI * k as f64 / m as f64;
                positions.push([x, axis[0] + radius * phi.cos(), axis[1] + radius * phi.sin()]);
            }
        }
    }
    // Ring index: end e (0, 1), radius kind k (0 inner, 1 outer), segment s.
    let id = |e: usize, k: usize, s: usize| ((e * 2 + k) * m + s % m) as u32;
    let mut tris = Vec::new();
    let mut tags = Vec::new();
    for s in 0..m {
        for k in 0..2 {
            tris.push([id(0, k, s), id(1, k, s), id(1, k, s + 1)]);
            tris.push([id(0, k, s), id(1, k, s + 1), id(0, k, s + 1)]);
            tags.extend([k as u32; 2]);
        }
        for e in 0..2 {
            tris.push([id(e, 0, s), id(e, 1, s), id(e, 1, s + 1)]);
            tris.push([id(e, 0, s), id(e, 1, s + 1), id(e, 0, s + 1)]);
            tags.extend([2 + e as u32; 2]);
        }
    }
    surface(positions, tris, tags, move |p, tag| {
        let radial = [0.0, p[1] - axis[0], p[2] - axis[1]];
        match tag {
            0 => radial.map(|c| -c),
            1 => radial,
            2 => [-1.0, 0.0, 0.0],
            _ => [1.0, 0.0, 0.0],
        }
    })
}

/// A circular cylinder along z from `z0` to `z1` about (`x`, `y`), radius `r`, `m` segments.
/// Faces: 0 the side, 1 the bottom, 2 the top.
pub fn cylinder(centre: [f64; 2], r: f64, z0: f64, z1: f64, m: usize) -> BoundarySurface {
    let mut positions = Vec::new();
    for z in [z0, z1] {
        for k in 0..m {
            let phi = 2.0 * std::f64::consts::PI * k as f64 / m as f64;
            positions.push([centre[0] + r * phi.cos(), centre[1] + r * phi.sin(), z]);
        }
    }
    positions.push([centre[0], centre[1], z0]);
    positions.push([centre[0], centre[1], z1]);
    let id = |e: usize, s: usize| (e * m + s % m) as u32;
    let (bottom, top) = ((2 * m) as u32, (2 * m + 1) as u32);
    let mut tris = Vec::new();
    let mut tags = Vec::new();
    for s in 0..m {
        tris.push([id(0, s), id(0, s + 1), id(1, s + 1)]);
        tris.push([id(0, s), id(1, s + 1), id(1, s)]);
        tags.extend([0, 0]);
        tris.push([bottom, id(0, s + 1), id(0, s)]);
        tags.push(1);
        tris.push([top, id(1, s), id(1, s + 1)]);
        tags.push(2);
    }
    surface(positions, tris, tags, move |p, tag| match tag {
        0 => [p[0] - centre[0], p[1] - centre[1], 0.0],
        1 => [0.0, 0.0, -1.0],
        _ => [0.0, 0.0, 1.0],
    })
}

pub fn obstacle(body: &str, surface: BoundarySurface, faces: &[&str]) -> Obstacle {
    Obstacle { body: body.into(), surface, faces: faces.iter().map(|s| s.to_string()).collect() }
}