Typedefs
typedef int	F5_gridproperty_t(F5Path grid, const char coordinate_system)

Functions
F5_API int	F5P_is_uniform (F5Path grid, const char coordinate_system)

F5_API int	F5P_is_Zstacked (F5Path grid, const char coordinate_system)

F5_API int	F5P_is_rectilinear (F5Path grid, const char coordinate_system)

F5_API int	F5P_is_curvilinear (F5Path grid, const char coordinate_system)

F5_API int	F5P_is_triangular_surface (F5Path grid, const char coordinate_system)

F5_API int	F5P_is_particle_system (F5Path grid, const char coordinate_system)

F5_API int	F5P_has_vertices (F5Path grid, const char coordinate_system)

F5_API int	F5P_has_vertex_fields (F5Path grid, const char coordinate_system)

F5_API int	F5P_has_cell_fields (F5Path grid, const char coordinate_system)

Detailed Description

Typedef Documentation

◆ F5_gridproperty_t

typedef int F5_gridproperty_t(F5Path *grid, const char *coordinate_system)

Prototype for functions determining grid properties.

Returns: true if the property is matched, otherwise false.

Examples: RegularReader.c.

Function Documentation

◆ F5P_has_cell_fields()

F5_API int F5P_has_cell_fields	(	F5Path *	grid,
		const char *	coordinate_system
	)

Check if the grid has some data fields defined on its cells

◆ F5P_has_vertex_fields()

F5_API int F5P_has_vertex_fields	(	F5Path *	grid,
		const char *	coordinate_system
	)

Check if the grid has some fields in the specified coordinate system

◆ F5P_has_vertices()

F5_API int F5P_has_vertices	(	F5Path *	grid,
		const char *	coordinate_system
	)

Check if the grid has positions in the specified coordinate system

References F5Dexist(), F5Gexist(), F5Path::Grid_hid, and F5Path::Topology_hid.

◆ F5P_is_curvilinear()

F5_API int F5P_is_curvilinear	(	F5Path *	grid,
		const char *	coordinate_system
	)

The grid is curvilinear if the positions is a dataset of rank n with n>1 or it is a group with n scalar field that are named like the coordinate entries.

References F5Path::Grid_hid.

◆ F5P_is_particle_system()

F5_API int F5P_is_particle_system	(	F5Path *	grid,
		const char *	coordinate_system
	)

No Connectivity information is given, and the dimensionality of the Positions is 1.

◆ F5P_is_Zstacked()

F5_API int F5P_is_Zstacked	(	F5Path *	grid,
		const char *	coordinate_system
	)

A grid is ‘Z-stacked’ if its coordinates in a certain chart are uniform in all coordinates but the last one, which is given as a one-dimensional dataset.