Struct Parameters 

pub struct Parameters<R: Scalar> {
    pub particle_radius: R,
    pub rest_density: R,
    pub compact_support_radius: R,
    pub cube_size: R,
    pub iso_surface_threshold: R,
    pub particle_aabb: Option<Aabb3d<R>>,
    pub enable_multi_threading: bool,
    pub enable_simd: bool,
    pub spatial_decomposition: SpatialDecomposition,
    pub global_neighborhood_list: bool,
}

Parameters for the surface reconstruction

Fields

particle_radius: R

Radius per particle (used to calculate the particle volume)

rest_density: R

Rest density of the fluid

compact_support_radius: R

Compact support radius of the kernel, i.e. distance from the particle where kernel reaches zero (in distance units, not relative to particle radius)

cube_size: R

Edge length of the marching cubes implicit background grid (in distance units, not relative to particle radius)

iso_surface_threshold: R

Relative rest density threshold value to distinguish between the inside (above threshold) and outside (below threshold) of the fluid

particle_aabb: Option<Aabb3d<R>>

Bounding box of particles to reconstruct

All particles outside of this domain will be filtered out before the reconstruction. The surface reconstruction always results in a closed mesh around the particles. The final mesh can extend beyond this AABB due to the smoothing of the kernel. If not provided, the smallest AABB enclosing all particles is computed instead.

enable_multi_threading: bool

Whether to allow multi threading within the surface reconstruction procedure

enable_simd: bool

Whether to enable SIMD vectorization for some computations if supported by the target architecture

Currently only supported on x86/x86_64 (AVX2 + FMA) and aarch64 (NEON) for single precision (f32) reconstructions.

spatial_decomposition: SpatialDecomposition

Parameters for the spatial decomposition of the surface reconstruction If not provided, no spatial decomposition is performed and a global approach is used instead.

global_neighborhood_list: bool

Whether to return the global particle neighborhood list from the reconstruction. Depending on the settings of the reconstruction, neighborhood lists are only computed locally in subdomains. Enabling this flag joins this data over all particles which can add a small overhead.

Implementations

impl<R: Real> Parameters<R>

pub fn new(particle_radius: R, compact_support_radius: R, cube_size: R) -> Self

Creates a new set of parameters with the specified (absolute) parameters and default values for the rest

The arguments are in absolute distance units, not relative to the particle radius. A default rest density of 1000.0 and iso surface threshold of 0.6 is used. Multi threading and spatial decomposition is enabled.

pub fn new_relative( particle_radius: R, relative_compact_support_radius: R, relative_cube_size: R, ) -> Self

Creates a new set of parameters with the specified parameters relative to the particle radius and default values for the rest

The arguments are relative to the particle radius, i.e. the actual values are computed as particle_radius * relative_*. For the remaining parameters, see Parameters::new.

pub fn try_convert<T: Real>(&self) -> Option<Parameters<T>>

Tries to convert the parameters from one Real type to another Real type, returns None if conversion fails

Trait Implementations

impl<R: Clone + Scalar> Clone for Parameters<R>

fn clone(&self) -> Parameters<R>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Debug + Scalar> Debug for Parameters<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.