sim-lib-interference-core 0.1.0

Validated physical boundary types for coherent scalar wave-field studies.
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

#![forbid(unsafe_code)]
//! Checked physical boundaries for coherent scalar wave-field studies.
//!
//! This crate owns the dependency-free quantity, source, sampling, and
//! preflight vocabulary used by the interference family. It deliberately does
//! not define grid solving, tensor storage, runtime bindings, or presentation.
//!
//! # Scope boundary
//!
//! The model is homogeneous, isotropic, three-dimensional, scalar, and
//! free-field. It does not model polarization, impedance, interfaces,
//! obstacles, or diffraction. Downstream amplitude-squared observations are
//! normalized proxies, not physical intensity, power, or energy.
//!
//! # Governing convention
//!
//! The real field is `u(x, t) = Re{U(x) * exp(-i * omega * t)}`. In a
//! homogeneous scalar medium,
//! `k_tilde = omega / c + i * alpha` and, away from point sources,
//! `laplacian(U) + k_tilde^2 * U = 0`.
//!
//! A point emitter contributes
//! `A * (R_ref / r) * exp(i * k_tilde * r + i * phase)`, where
//! [`POINT_SOURCE_REFERENCE_DISTANCE_METRES`] defines `R_ref`. A forward-plane
//! emitter contributes `A * exp(i * k_tilde * s + i * phase)` only for
//! non-negative signed distance `s`. The positive propagation sign is outgoing
//! under the `exp(-i * omega * t)` time convention, and the imaginary part of
//! `k_tilde` gives `exp(-alpha * distance)` attenuation.
//!
//! [`SamplingPlane`] defines physical pixel centres in an orthonormal finite
//! frame. [`SamplingCertificate`] measures carrier phase, half-wavelength
//! squared-magnitude fringes, and point-source `1/r` envelope change against
//! explicit [`SamplingThresholds`]. [`RequestPreflight`] applies
//! [`SamplingPolicy`] and [`WorkBudget`] before a solver allocates field
//! storage.

mod budget;
mod certificate;
mod emitter;
mod error;
mod geometry;
mod medium;
mod problem;
mod propagation;
mod quantity;
mod sampling;

pub use budget::{RequestPreflight, WorkBudget, WorkEstimate, WorkMetric};
pub use certificate::{SamplingCertificate, SamplingPolicy, SamplingThresholds, SamplingVerdict};
pub use emitter::{Emitter, SourceSet};
pub use error::InterferenceError;
pub use geometry::{Point3M, UnitVector3};
pub use medium::{ScalarMedium, WaveNumber};
pub use problem::{InterferenceProblem, POINT_SOURCE_REFERENCE_DISTANCE_METRES};
pub use propagation::{contribution_at, forward_plane_contribution_at, point_contribution_at};
pub use quantity::{
    FieldAmplitude, Hertz, Metres, MetresPerSecond, NepersPerMetre, PositiveMetres, Radians,
};
pub use sampling::{SAMPLING_AXIS_ORTHOGONALITY_TOLERANCE, SamplingPlane};