gruvoc.avmfile: Tools for reading CREATE-AV avm files

This module provides functions to read and write .avm files, which are the main unstructured grid format for Kestrel.

cape.gruvoc.avmfile.read_avm(mesh: UmeshBase, fname_or_fp: str | IOBase, meta: bool = False)

Read data to a mesh object from .avm file

Call:

>>> read_avm(mesh, fname, meta=False)
>>> read_avm(mesh, fp, meta=False)

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.)

cape.gruvoc.avmfile.write_avm(mesh: UmeshBase, fname_or_fp: str | IOBase)

Write data from a mesh object to .avm file

Call:

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

Inputs:

mesh: Umesh

Unstructured mesh object

fname: str

Name of file

fp: IOBase

File object