tree mesh -- to finalize or not?

[Lindsey Heagy]

Currently, the implementations of utils for refining tree meshes are inconsistent with the default value for finalize

utils.refine_tree_xyz has a default value of False

discretize/discretize/utils/mesh_utils.py

Lines 556 to 565 in c6ea5eb

 def refine_tree_xyz( 
     mesh, 
     xyz, 
     method="radial", 
     octree_levels=[1, 1, 1], 
     octree_levels_padding=None, 
     finalize=False, 
     min_level=0, 
     max_distance=np.inf, 
 ): 

whereas mesh.refine_ball has a default True

discretize/discretize/_extensions/tree_ext.pyx

Line 502 in c6ea5eb

 def refine_ball(self, points, radii, levels, finalize=True): 

which can be a source of confusion... I would vote for finalize=False as the default (at least in most use cases I have encountered, I am doing multiple refinement steps), but don't have overly strong opinions -- other than it would be useful if they were consistent.

And on a related note, there are no errors / warnings thrown if you try to refine a mesh that has already been finalized. So it might be worth a quick check & error if the mesh has already been finalized.