Struct splashsurf_lib::octree::Octree

impl<I: Index, R: Real> Octree<I, R>

pub fn new(grid: &UniformGrid<I, R>, n_particles: usize) -> Self

Creates a new octree with a single leaf node containing all vertices

pub fn new_subdivided( grid: &UniformGrid<I, R>, particle_positions: &[Vector3<R>], subdivision_criterion: SubdivisionCriterion, margin: R, enable_multi_threading: bool, enable_stitching: bool ) -> Self

Create a new octree and perform subdivision with the specified margin

The margin is used to assign ghost particles to octree nodes. Each octant resulting from the subdivision gets assigned all particles that are directly inside it plus all particles from its parent that are within the given margin around the octant.

pub fn root(&self) -> &OctreeNode<I, R>

Returns a reference to the root node of the octree

pub fn root_mut(&mut self) -> &mut OctreeNode<I, R>

Returns a mutable reference to the root node of the octree

pub fn subdivide_recursively_margin( &mut self, grid: &UniformGrid<I, R>, particle_positions: &[Vector3<R>], subdivision_criterion: SubdivisionCriterion, margin: R, enable_stitching: bool )

Subdivide the octree recursively using the given splitting criterion and a margin to add ghost particles

pub fn par_subdivide_recursively_margin( &mut self, grid: &UniformGrid<I, R>, particle_positions: &[Vector3<R>], subdivision_criterion: SubdivisionCriterion, margin: R, enable_stitching: bool )

Subdivide the octree recursively and in parallel using the given splitting criterion and a margin to add ghost particles

pub fn hexmesh( &self, grid: &UniformGrid<I, R>, only_non_empty: bool ) -> MeshWithData<R, HexMesh3d<R>>

Constructs a hex mesh visualizing the cells of the octree, may contain hanging and duplicate vertices as cells are not connected

Trait Implementations§

impl<I: Clone + Index, R: Clone + Real> Clone for Octree<I, R>

fn clone(&self) -> Octree<I, R>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<I: Debug + Index, R: Debug + Real> Debug for Octree<I, R>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<I, R> RefUnwindSafe for Octree<I, R>where I: RefUnwindSafe, R: RefUnwindSafe,

impl<I, R> UnwindSafe for Octree<I, R>where I: UnwindSafe, R: UnwindSafe,

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V