User API

This page shows already-implemented Uxarray user API functions. You can also check the draft Uxarray API documentation to see the tentative whole API and let us know if you have any feedback!

Grid Class

grid.Grid(dataset, **kwargs)

The Uxarray Grid object class that describes an unstructured grid.

Grid Methods

grid.Grid.write(outfile[, extension])	Writes mesh file as per extension supplied in the outfile string.
grid.Grid.calculate_total_face_area([...])	Function to calculate the total surface area of all the faces in a mesh.
grid.Grid.integrate(var_key[, ...])	Integrates over all the faces of the given mesh.
grid.Grid.compute_face_areas([...])	Face areas calculation function for grid class, calculates area of all faces in the grid.

Helper Functions

helpers.get_all_face_area_from_coords(x, y, ...)	Given coords, connectivity and other area calculation params, this routine loop over all faces and return an numpy array with areas of each face.
helpers.calculate_face_area(x, y, z[, ...])	Calculate area of a face on sphere.
helpers.calculate_spherical_triangle_jacobian(...)	Calculate Jacobian of a spherical triangle.
helpers.calculate_spherical_triangle_jacobian_barycentric(...)	Calculate Jacobian of a spherical triangle.
get_gauss_quadratureDG(nCount)	Gauss Quadrature Points for integration.
get_tri_quadratureDG(nOrder)	Triangular Quadrature Points for integration.
helpers.parse_grid_type(filepath, **kw)	Checks input and contents to determine grid type.