Skip to content

Commit fd747d6

Browse files
committed
Update comment
1 parent cc75e5c commit fd747d6

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

splashsurf_lib/src/density_map.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
//! This module provides functions for the computation of per-particle densities and the discretization
44
//! of the resulting fluid density field by mapping onto a discrete background grid.
55
//!
6-
//! Currently, only sparse density maps are implemented.
76
//!
87
//! ## Sparse density maps
98
//! The [`DensityMap`] stores fluid density values for each point of an implicit background grid
@@ -15,6 +14,12 @@
1514
//! `[n_x, n_y, n_z]`, the flat point index is given by the expression `i*n_y*n_z + j*n_z + k`.
1615
//! For these point index operations, the [`UniformGrid`] is used.
1716
//!
17+
//! ## Dense density maps
18+
//! For some applications, it might be desirable to allocate the storage for all grid points
19+
//! in a contiguous array. This is supported by the [`DensityMap::Dense`] variant. The values
20+
//! can either be borrowed (a slice) or owned (a vector). Background grid coordinates are mapped
21+
//! to indices in this array (and vice versa) using the same flattening scheme as for the sparse maps.
22+
//!
1823
//! Note that all density mapping functions always use the global background grid for flat point
1924
//! indices, even if the density map is only generated for a smaller subdomain.
2025

0 commit comments

Comments
 (0)