Reference
Contents
Index
SplitVOF.AdvectionMethodSplitVOF.CartesianGrid2DSplitVOF.CartesianGrid2DSplitVOF.CartesianGrid3DSplitVOF.CartesianGrid3DSplitVOF.ELVIRANormalSplitVOF.HeightFunctionNormalSplitVOF.InterfaceMethodSplitVOF.LieSplitSplitVOF.NormalMethodSplitVOF.PLICSplitVOF.ReconstructionSplitVOF.ReconstructionMethodSplitVOF.SLICSplitVOF.SplitVOFGridSplitVOF.SplitVOFGrid3DSplitVOF.SplitVOFParamsSplitVOF.StrangSplitSplitVOF.YoungsNormalSplitVOF.YoungsPLICSplitVOF._step_lie!SplitVOF._step_lie!SplitVOF._wrapSplitVOF.cell_boundsSplitVOF.cell_boundsSplitVOF.cell_centerSplitVOF.cell_centerSplitVOF.circle_levelsetSplitVOF.compdtSplitVOF.compute_dtSplitVOF.dimensionSplitVOF.elvira_normals!SplitVOF.fractgSplitVOF.height_function_normals!SplitVOF.initfgrid!SplitVOF.initfgrid!SplitVOF.integrate!SplitVOF.integrate!SplitVOF.is_emptySplitVOF.is_fullSplitVOF.is_mixedSplitVOF.l1_errorSplitVOF.l2_errorSplitVOF.linf_errorSplitVOF.reconstruct!SplitVOF.reconstruct!SplitVOF.reconstruct!SplitVOF.shape_metricsSplitVOF.sphere_levelsetSplitVOF.splitgridSplitVOF.splitgridSplitVOF.splitgridSplitVOF.step!SplitVOF.step!SplitVOF.vofadv!SplitVOF.vofadv!SplitVOF.vofgridSplitVOF.volumeSplitVOF.youngs_normals!SplitVOF.youngs_normals!SplitVOF.zalesak_levelset
API Reference
SplitVOF.AdvectionMethod — Type
Abstract supertype for advection/integration algorithms.
SplitVOF.CartesianGrid2D — Type
Uniform 2D Cartesian grid descriptor.
SplitVOF.CartesianGrid2D — Method
Build a 2D Cartesian grid from domain limits and cell counts.
SplitVOF.CartesianGrid3D — Type
Uniform 3D Cartesian grid descriptor.
SplitVOF.CartesianGrid3D — Method
Build a 3D Cartesian grid from domain limits and cell counts.
SplitVOF.ELVIRANormal — Type
ELVIRA-style normal selected by local volume-fraction stencil scoring. Currently implemented for 2D split grids.
SplitVOF.HeightFunctionNormal — Type
Height-function normal. Currently implemented for 2D split grids.
SplitVOF.InterfaceMethod — Type
Abstract supertype for interface representations.
SplitVOF.LieSplit — Type
First-order Lie directional splitting advection scheme.
SplitVOF.NormalMethod — Type
Abstract supertype for normal-vector reconstruction algorithms.
SplitVOF.PLIC — Type
Piecewise-linear interface representation.
SplitVOF.Reconstruction — Type
Composable reconstruction selector.
SplitVOF.ReconstructionMethod — Type
Abstract supertype for interface-reconstruction algorithms.
SplitVOF.SLIC — Type
Youngs gradient direction reduced to an axis-aligned SLIC interface.
SplitVOF.SplitVOFGrid — Type
2D split-VOF state container.
SplitVOF.SplitVOFGrid3D — Type
3D split-VOF state container.
SplitVOF.SplitVOFParams — Type
Simulation parameters for split geometric VOF on a Cartesian grid.
Key fields:
nx, ny, nz: number of cellsxlim, ylim, zlim: domain boundscfl: target CFL forcompute_dt/integrate!tol: interface tolerance for empty/full detectionreconstruction,advection: algorithm selectors
SplitVOF.StrangSplit — Type
Directional Strang splitting advection scheme.
SplitVOF.YoungsNormal — Type
Youngs volume-fraction gradient normal.
SplitVOF.YoungsPLIC — Type
Youngs gradient-based normal reconstruction with PLIC volume enforcement.
SplitVOF._step_lie! — Method
Advance one split-advection step in 2D using first-order Lie splitting.
SplitVOF._step_lie! — Method
Advance one split-advection step in 3D using first-order Lie splitting.
SplitVOF._wrap — Method
Periodic index wrap helper: maps indices outside 1:n back into range.
SplitVOF.cell_bounds — Method
Return (xL, xR, yB, yT) bounds of 2D cell (i, j).
SplitVOF.cell_bounds — Method
Return (xL, xR, yB, yT, zD, zU) bounds of 3D cell (i, j, k).
SplitVOF.cell_center — Method
Return center coordinates of a 2D cell as SVector{2}.
SplitVOF.cell_center — Method
Return center coordinates of a 3D cell as SVector{3}.
SplitVOF.circle_levelset — Function
Build a circular implicit function for 2D initialization.
SplitVOF.compdt — Function
Alias for compute_dt.
SplitVOF.compute_dt — Method
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.
SplitVOF.dimension — Method
Return spatial dimension (2 or 3) of a split-VOF state.
SplitVOF.elvira_normals! — Method
Compute ELVIRA-style interface normals in 2D and store in nxint, nyint.
SplitVOF.fractg — Method
Return the volume-fraction array stored in the split-VOF state.
SplitVOF.height_function_normals! — Method
Compute height-function interface normals in 2D and store in nxint, nyint.
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 liquidf < 0: outside liquid
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 liquidf < 0: outside liquid
SplitVOF.integrate! — Method
Integrate to tf using algorithm choice in params.
SplitVOF.integrate! — Method
Integrate from current time vg.t to final time tf.
SplitVOF.is_empty — Method
Return true if cell is empty (α <= tol).
SplitVOF.is_full — Method
Return true if cell is full (α >= 1 - tol).
SplitVOF.is_mixed — Method
Return true if cell is mixed (tol < α < 1 - tol).
SplitVOF.l1_error — Method
L1 error of the volume-fraction field against a reference field.
SplitVOF.l2_error — Method
L2 error of the volume-fraction field against a reference field.
SplitVOF.linf_error — Method
L∞ error of the volume-fraction field against a reference field.
SplitVOF.reconstruct! — Method
Reconstruct 3D PLIC planes (cplic) from the current volume fractions.
SplitVOF.reconstruct! — Method
Reconstruct 2D PLIC planes (cplic) from the current volume fractions.
SplitVOF.reconstruct! — Method
Dispatch reconstruction based on params.reconstruction.
SplitVOF.shape_metrics — Method
Compute bulk shape descriptors from the volume-fraction field.
Returns a named tuple:
volumecentroidsecond_moments(central second-moment tensor)
SplitVOF.sphere_levelset — Function
Build a spherical implicit function for 3D initialization.
SplitVOF.splitgrid — Function
Allocate and initialize a split-VOF state from SplitVOFParams.
Returns SplitVOFGrid when nz <= 1, otherwise SplitVOFGrid3D.
SplitVOF.splitgrid — Method
Allocate a 2D split-VOF state from an existing Cartesian grid.
SplitVOF.splitgrid — Method
Allocate a 3D split-VOF state from an existing Cartesian grid.
SplitVOF.step! — Method
Advance one split-advection step in 2D using Strang splitting.
SplitVOF.step! — Method
Advance one split-advection step in 3D using symmetric split sweeps.
SplitVOF.vofadv! — Method
Advance one advection step using algorithm choice in params.
SplitVOF.vofadv! — Method
Alias for step!.
SplitVOF.vofgrid — Function
Alias for splitgrid(params).
SplitVOF.volume — Method
Total material volume (area in 2D) represented by the volume-fraction field.
SplitVOF.youngs_normals! — Method
Compute Youngs interface normals in 3D and store in nxint, nyint, nzint.
SplitVOF.youngs_normals! — Method
Compute Youngs interface normals in 2D and store in nxint, nyint.
SplitVOF.zalesak_levelset — Method
Build the standard Zalesak slotted-disk implicit function.