scirs2-integrate 0.4.2

Numerical integration module for SciRS2 (scirs2-integrate)
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

//! Differential Algebraic Equation (DAE) solvers
//!
//! This module provides numerical solvers for differential algebraic equations (DAEs).
//! DAEs are a more general class of equations than ODEs and include algebraic constraints.
//!
//! Features:
//! - Support for index-1 DAE systems
//! - Semi-explicit DAE solvers for specialized forms
//! - Implicit DAE solvers for general forms
//! - Integration with mass matrix functionality
//! - Specialized BDF methods for DAE systems
//!
//! DAEs can be classified based on their index, which roughly corresponds to the
//! number of times one must differentiate the constraint equations to obtain an ODE.
//! This module focuses primarily on index-1 DAEs, which are the most common in practice.
//!
//! ## Semi-explicit Form
//!
//! Semi-explicit DAEs have the form:
//! ```text
//! x' = f(x, y, t)
//! 0 = g(x, y, t)
//! ```
//! where x are differential variables and y are algebraic variables.
//!
//! ## Fully-implicit Form
//!
//! Fully-implicit DAEs have the form:
//! ```text
//! F(t, y, y') = 0
//! ```
//! where all variables are treated uniformly and the system equations
//! depend on both the variables and their derivatives.

// Public types module
pub mod types;

// Public modules
pub mod index_reduction;
pub mod methods;
pub mod solvers;
pub mod utils;

// Re-export core types
pub use self::types::{DAEIndex, DAEOptions, DAEResult, DAEType};

// Re-export solver functions
pub use self::solvers::{
    solve_higher_index_dae, solve_implicit_dae, solve_ivp_dae, solve_semi_explicit_dae,
};

// Re-export specialized method functions
pub use self::methods::bdf_dae::{bdf_implicit_dae, bdf_semi_explicit_dae};
pub use self::methods::index_reduction_bdf::{
    bdf_implicit_with_index_reduction, bdf_with_index_reduction,
};
pub use self::methods::krylov_dae::{krylov_bdf_implicit_dae, krylov_bdf_semi_explicit_dae};

// Re-export preconditioner functions
pub use self::methods::block_precond::{
    create_block_ilu_preconditioner, create_block_jacobi_preconditioner,
};

// Re-export index reduction types
pub use self::index_reduction::{
    DAEStructure, DummyDerivativeReducer, PantelidesReducer, ProjectionMethod,
};

// Re-export Radau IIA DAE solver
pub use self::methods::radau::{
    estimate_dae_index, find_consistent_initial_conditions, radau_iia_dae, ImplicitDAESystem,
};