colin
/
fdtd-coremem
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

mb_pgram: better docs

This commit is contained in:
colin 2022-10-02 04:39:04 -07:00
parent ae3ac2717b
commit c9dd27f741
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
crates/cross/src/mat/mb_pgram.rs
View File

@ -10,11 +10,11 @@ use serde::{Serialize, Deserialize};
/// M(B) parallelogram
///
///```ignore
/// ____________
/// ____________ (P1)
/// / /
/// / . /
/// / /
/// /___________/
/// /___________/ (P0)
/// ```
///
/// The `.` depicts (0, 0). X axis is B; y axis is M.
@ -26,10 +26,13 @@ use serde::{Serialize, Deserialize};
#[derive(Copy, Clone, Default, PartialEq)]
pub struct MBPgram<R> {
/// X coordinate at which the upward slope starts
/// X coordinate for point P0 in the diagram above.
pub b_start: R,
/// X coordinate at which the upward slope ends
/// X coordinate for point P1 in the diagram above.
pub b_end: R,
/// Vertical range of the graph
/// Y coordinate for point P1, negative Y coordinate for point P0, in the diagram above.
pub max_m: R,
}