Reference

Contents

Index

API Reference

SplitVOF.ELVIRANormalType

ELVIRA-style normal selected by local volume-fraction stencil scoring. Currently implemented for 2D split grids.

source
SplitVOF.SLICType

Youngs gradient direction reduced to an axis-aligned SLIC interface.

source
SplitVOF.SplitVOFParamsType

Simulation parameters for split geometric VOF on a Cartesian grid.

Key fields:

  • nx, ny, nz: number of cells
  • xlim, ylim, zlim: domain bounds
  • cfl: target CFL for compute_dt/integrate!
  • tol: interface tolerance for empty/full detection
  • reconstruction, advection: algorithm selectors
source
SplitVOF._wrapMethod

Periodic index wrap helper: maps indices outside 1:n back into range.

source
SplitVOF.compute_dtMethod

Compute a stable time step from face-velocity CFL constraints.

Supports velocity call signatures (x,t), (x,y,t)/(x,y,z,t), (x), or coordinate-only variants.

source
SplitVOF.initfgrid!Method

Initialize 2D volume fractions from an implicit level-set function.

f can accept either (x, y) or SVector{2} and is interpreted as:

  • f > 0: inside liquid
  • f < 0: outside liquid
source
SplitVOF.initfgrid!Method

Initialize 3D volume fractions from an implicit level-set function.

f can accept either (x, y, z) or SVector{3} and is interpreted as:

  • f > 0: inside liquid
  • f < 0: outside liquid
source
SplitVOF.shape_metricsMethod

Compute bulk shape descriptors from the volume-fraction field.

Returns a named tuple:

  • volume
  • centroid
  • second_moments (central second-moment tensor)
source
SplitVOF.splitgridFunction

Allocate and initialize a split-VOF state from SplitVOFParams.

Returns SplitVOFGrid when nz <= 1, otherwise SplitVOFGrid3D.

source
SplitVOF.volumeMethod

Total material volume (area in 2D) represented by the volume-fraction field.

source