gruvoc.ugridfile: Tools for reading AFLR3 ugrid files

One key functionality of this module is to determine the file type of .ugrid files or determine that they are not recognizable files of that format.

class cape.gruvoc.surf3dfile.Surf3DFileType(fmt, byteorder, filetype, precision, blds, bldel)

bldel

Alias for field number 5

blds

Alias for field number 4

byteorder

Alias for field number 1

filetype

Alias for field number 2

fmt

Alias for field number 0

precision

Alias for field number 3

cape.gruvoc.surf3dfile.get_surf3d_mode(fname_or_fp: IOBase | str, fmt: str | None = None) → Surf3DFileType | None

Identify UGRID file format if possible

Call:

>>> mode = get_surf3d_mode(fname_or_fp, fmt=None)

Outputs:

mode: None | Surf3DFileType

File type, big|little endian, stream|fortran, etc.

cape.gruvoc.surf3dfile.read_surf3d(mesh: UmeshBase, fname_or_fp: str | IOBase, meta: bool = False, fmt: str | None = None)

Read data to a mesh object from .surf file

Call:

>>> read_surf3d(mesh, fname, meta=False, fmt=None)
>>> read_surf3d(mesh, fp, meta=False, fmt=None)

Inputs:

mesh: Umesh

Unstructured mesh object

fname: str

Name of file

fp: IOBase

File object

meta: True | {False}

Read only metadata (number of nodes, tris, etc.)

fmt: {None} | str

Manual data format, "l?[br][48]l?"

cape.gruvoc.surf3dfile.write_surf3d(mesh: UmeshBase, fname_or_fp: str | IOBase, fmt: str | None = None)

Write data from a mesh object to .surf file

Call:

>>> write_surf3d(mesh, fname, fmt=None)
>>> write_surf3d(mesh, fp, fmt=None)

Inputs:

mesh: Umesh

Unstructured mesh object

fname: str

Name of file

fp: IOBase

File object

fmt: {None} | str

Manual data format, "l?[br][48]l?"