3D Frame Fields

VolumeFrameField

3D version of frame fields, implemented as L4 Spherical Harmonics.

Parameters:

Name	Type	Description	Default
`mesh`	`VolumeMesh`	the supporting mesh	required
`elements`	`str`	"vertices" or "cells", the mesh elements onto which the frames live.	required

Other Parameters:

Name	Type	Description
`features`	`bool`	Whether to consider feature edges or not. Has no effect on the cell implementation. Defaults to True.
`n_smooth`	`int`	Number of smoothing steps to perform. Defaults to 1.
`smooth_attach_weight`	`float`	Custom attach weight to previous solution during smoothing steps. If not provided, will be estimated automatically before optimization. Defaults to None.
`verbose`	`bool`	verbose mode. Defaults to False.
`custom_boundary_features`	`FeatureEdgeDetector`	custom feature edges to be used in frame field optimization. If not provided, feature edges will be automatically detected. If the 'features' flag is set to False, features of this object are ignored. Has no effect on the cell implementation. Defaults to None.

Returns:

Name	Type	Description
`Framefield`	`FrameField`	a frame field object with the correct settings

References