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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! A Rust port of the Monte-Carlo particle transport proxy-app [Quicksilver][1].
//!
//! Fastiron mimics Monte-Carlo particle transport code to study their behavior on
//! various hardware architectures. The aim of this port is to evaluate Rust's
//! capabilities and performances in the context of parallel programming and
//! scaling problem size.
//!
//! # Quickstart
//!
//! After cloning the [repository][2], fastiron can be executed like any other Rust
//! program using cargo. Run the following:
//! ```shell
//! $ cargo build --release
//! $ cargo run --bin=fastiron
//! ```
//!
//! And see the CLI's usage:
//! ```shell
//! $ cargo run --bin=fastiron
//!
//! Fastiron, a Rust port of the Quicksilver proxy-app
//!
//! Usage: fastiron [OPTIONS]
//!
//! Options:
//!   -i, --input-file <INPUT_FILE>
//!           name of input file
//!   -e, --energy-spectrum <ENERGY_SPECTRUM>
//!           name of energy spectrum output file
//!   -S, --cross-sections <CROSS_SECTIONS_OUT>
//!           name of cross-section output file
//!   -D, --dt <DT>
//!           time step in seconds
//!   -l, --load-balance
//!           enable load balancing if present
//!   -c, --csv
//!           write tallies & timer data into csv files if present
//!   -t, --debug-threads
//!           enable thread debugging if present
//!   -p, --single-precision
//!           enable single-precision float type usage if present
//!   -X, --lx <LX>
//!           x-size of simulation in cm
//!   -Y, --ly <LY>
//!           y-size of simulation in cm
//!   -Z, --lz <LZ>
//!           z-size of simulation in cm
//!   -n, --n-particles <N_PARTICLES>
//!           total number of particles
//!   -C, --chunk-size <CHUNK_SIZE>
//!           size of the chunks when executing in parallel -- if absent or set to 0, use dynamic chunk size
//!   -r, --rayon <N_RAYON_THREADS>
//!           number of rayon threads that should be used to run the simulation -- set to 0 for rayon's default config
//!   -u, --units <N_UNITS>
//!           number of units that should be used to run the simulation
//!   -N, --n-steps <N_STEPS>
//!           number of steps simulated
//!   -x, --nx <NX>
//!           number of mesh elements along x
//!   -y, --ny <NY>
//!           number of mesh elements along y
//!   -z, --nz <NZ>
//!           number of mesh elements along z
//!   -s, --seed <SEED>
//!           random number seed
//!   -h, --help
//!          Print help
//!   -V, --version
//!           Print version
//!
//! ```
//!
//! # Example
//!
//! You can run one of the examples available using its input file. Note that the
//! parameters specified in the file take priority over the one specified as arguments:
//!
//! ```shell
//! $ cargo run --bin=fastiron --release -- -i input_files/QS_originals/Homogeneous/homogeneousProblem_v7_ts.inp -e energy -S section -n 10000
//! ```
//!
//! Fastiron will print the parameters and run the simulation. Two reports will
//! be printed at run-time and, if file names are specified, two files will be
//! created. These four outputs contain data such as event counts, timers value,
//! or final state of the system. To see more about these reports:
//! - [`Tallies::print_summary()`][crate::data::tallies::Tallies::print_summary()]
//! - [`MCFastTimerContainer::cumulative_report()`][crate::utils::mc_fast_timer::MCFastTimerContainer::cumulative_report()]
//! - [`EnergySpectrum`][crate::data::energy_spectrum::EnergySpectrum]
//! - [`init::check_cross_sections()`]
//!
//! # Useful Links
//!
//! - Fastiron [GitHub repository][2]
//! - Quicksilver [GitHub repository][1]
//!
//! [1]: https://github.com/LLNL/Quicksilver
//! [2]: https://github.com/cea-hpc/fastiron

#![warn(clippy::disallowed_types)]
#![allow(clippy::doc_lazy_continuation)] // TODO: remove & fix lints

pub mod constants;
pub mod data;
pub mod geometry;
pub mod init;
pub mod montecarlo;
pub mod parameters;
pub mod particles;
pub mod simulation;
pub mod utils;