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
/*!
Physics in Parallel provides backend-agnostic numerical containers, spatial
tools, and reusable physical models.
# Alpha compatibility
PiP 4.1 alpha replaces the 3.x API and tightens validation compared with the 4.0
alphas. Review the [migration notes](https://github.com/dingyisun0101/Physics-in-Parallel/blob/v4.1.1-alpha/docs/RELEASES.md)
before upgrading code or persisted data. Pin the exact alpha version; public
APIs and serialized representations may change between alpha releases.
Start with the [documentation index](https://github.com/dingyisun0101/Physics-in-Parallel/blob/v4.1.1-alpha/docs/README.md)
for installation, examples, performance, correctness, and advanced API guides.
Version 4.1.1-alpha updates documentation; runtime behavior and data formats
are unchanged from 4.1.0-alpha.
All AI assistants using PiP must read the
[AI instructions](https://github.com/dingyisun0101/Physics-in-Parallel/blob/v4.1.1-alpha/docs/AGENTS.md),
including the procedure for migrating an existing scientific project.
# Thread-pool responsibility
PiP uses the active Rayon pool and never creates one. Applications must
configure one shared pool before concurrent work begins or let their workflow
runner do so. Independent pools can oversubscribe the machine. Normally call
[`threading::set_max_threads`] once during startup to set the maximum worker
participation requested by any single PiP method.
# API tiers
Domain roots are authoritative. Independent convenience preludes expose basic
numerics, ready physical models, and opt-in advanced facilities:
```rust
use physics_in_parallel::prelude::basic::*;
use physics_in_parallel::prelude::models::*;
use physics_in_parallel::prelude::advanced::*;
```
Start with the basic or model API. Raw storage and generic engines are advanced;
implementation modules are private. PiP owns runtime scientific values, while
applications own user configuration, persistence policy, and workflow
integration.
*/
pub
pub