discretize.mixins.TreeMeshIO.read_model_UBC

TreeMeshIO.read_model_UBC(file_name, directory=None)

Read UBC-GIF formatted file model file for 3D tree mesh (OcTree).

Parameters:

file_namestr or list of str

full path to the UBC-GIF formatted model file or just its name if directory is specified. It can also be a list of file_names.

directorystr

directory where the UBC-GIF file(s) lives (optional)

Returns:

(n_cells) numpy.ndarray or dict of [str, (n_cells) numpy.ndarray]

The model defined on the mesh. If file_name is a dict, it is a dictionary of models indexed by the file names.