cartan_maxwell/lib.rs
1//! Maxwell evolution on a prescribed evolving simplicial-Riemannian background.
2//!
3//! E is a 1-cochain (edges), B is a 2-cochain (faces). Faraday `dB/dt = -d1 E`
4//! is metric-free and exact; all metric and motion live in the time-dependent
5//! Hodge masses `M_1(t)`, `M_2(t)` supplied by a [`driver::MetricDriver`].
6//!
7//! Geometry is carried as squared edge lengths ([`MeshLengthsSq`]), the Regge
8//! primitive: the per-cell metric is linear in them and indefinite signatures
9//! stay representable.
10//!
11//! [`MeshLengthsSq`]: simplicial::geometry::metric::mesh::MeshLengthsSq
12//!
13//! ```
14//! use cartan_maxwell::{cfl_dt, coboundary_matrix, FlrwDriver, MaxwellEvolver, MaxwellState, MetricDriver};
15//! use derham::cochain::Cochain;
16//! use simplicial::r#gen::cartesian::CartesianGrid;
17//!
18//! // The identical evolver runs on a 2D or 3D spatial complex.
19//! for spatial_dim in [2usize, 3] {
20//! let (complex, coords) = CartesianGrid::new_unit(spatial_dim, 2).triangulate();
21//! let base = coords.to_edge_lengths_sq(&complex);
22//! let driver = FlrwDriver::static_metric(complex.clone(), base);
23//! let dt = cfl_dt(&driver.lengths_sq_at(0.0));
24//! let mut evolver = MaxwellEvolver::new(&driver, dt);
25//! let d1 = coboundary_matrix(&complex, 1);
26//! let seed = nalgebra::DVector::from_element(complex.nsimplices(1), 1.0);
27//! let b = Cochain::new(2, &d1 * &seed);
28//! let e = Cochain::new(1, nalgebra::DVector::zeros(complex.nsimplices(1)));
29//! let mut state = MaxwellState::new(e, b);
30//! evolver.step(&mut state, None);
31//! assert!(evolver.magnetic_gauss_residual(&state) < 1e-9);
32//! }
33//! ```
34
35pub mod driver;
36pub mod evolver;
37pub mod state;
38
39pub use driver::{FlrwDriver, MetricDriver};
40pub use evolver::{MaxwellEvolver, cfl_dt, coboundary_matrix};
41pub use state::MaxwellState;