Uniform Grids

Functions
F5_API F5Path *	F5Rcreate_uniform (hid_t File_id, double time, const char *gridname, const void *origin, const void *spacing, hsize_t *dims, const char *coordinate_system)
F5_API F5Path *	F5Rcreate_uniform_cartesian3D (hid_t file_id, double time, const char *gridname, const F5_vec3_point_t *origin, const F5_vec3_float_t *spacing, hsize_t dims[3], const char *coordinate_system)
F5_API F5Path *	F5Rcreate_uniform_cartesian3Dbbox (hid_t File_id, double time, const char *gridname, const F5_vec3_point_t *start, const F5_vec3_point_t *end, hsize_t dims[3], const char *coordinate_system)
F5_API F5Path *	F5Fwrite_uniform_cartesian3D (hid_t file_id, double time, const char *gridname, const F5_vec3_point_t *origin, const F5_vec3_float_t *spacing, hsize_t dims[3], const char *fieldname, hid_t fieldtype, const void *dataPtr, const char *coordinate_system, hid_t property_id)
F5_API int	F5write_uniform_cartesian3Dv (hid_t file_id, double time, const char *gridname, const F5_vec3_point_t *origin, const F5_vec3_float_t *spacing, hsize_t dims[3], const char *coordinate_system, hid_t property_id,...)
F5_API int	F5write_uniform_cartesian3Dvs (hid_t file_id, double time, const char *gridname, const F5_vec3_point_t *origin, const F5_vec3_float_t *spacing, hsize_t dims[3], const char *coordinate_system, hid_t property_id,...)
F5_API F5Path *	F5Fwrite_uniform_cartesian3Ds (hid_t file_id, double time, const char *gridname, const F5_vec3_point_t *origin, const F5_vec3_float_t *spacing, hsize_t dims[3], const char *fieldname, hid_t fieldtype, const void **dataPtr, const char *coordinate_system, hid_t property_id)
F5_API F5Path *	F5Rcreate_uniform_sparse (hid_t file_id, double time, const char *gridname, const void *origin, const void *spacing, hsize_t *dims, const char *coordinate_system, const hsize_t *sparse_idx_Ptr, const hsize_t sparse_size, hid_t property_id)
F5_API F5Path *	F5Rcreate_uniform_sparse2 (hid_t file_id, double time, const char *gridname, const F5_vec3_double_t *origin, const F5_vec3_double_t *spacing, hsize_t *dims, const char *coordinate_system, const hsize_t *sparse_idx_Ptr, hsize_t sparse_size, hid_t property_id)

Detailed Description

Function Documentation

F5Fwrite_uniform_cartesian3D()

F5_API F5Path* F5Fwrite_uniform_cartesian3D	(	hid_t	file_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	origin,
		const F5_vec3_float_t *	spacing,
		hsize_t	dims[3],
		const char *	fieldname,
		hid_t	fieldtype,
		const void *	dataPtr,
		const char *	coordinate_system,
		hid_t	property_id
	)

Write a data field given on uniform cartesian grid into file.

@param coordinate_system The coordinate system.
            May be NULL to refer to a standard chart.

Returns

A new F5Path pointer. Call F5close() if it is no longer used.

References F5close(), F5Fwrite(), and F5Rcreate_uniform_cartesian3D().

F5Fwrite_uniform_cartesian3Ds()

F5_API F5Path* F5Fwrite_uniform_cartesian3Ds	(	hid_t	file_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	origin,
		const F5_vec3_float_t *	spacing,
		hsize_t	dims[3],
		const char *	fieldname,
		hid_t	fieldtype,
		const void **	dataPtr,
		const char *	coordinate_system,
		hid_t	property_id
	)

Write a data field given on uniform cartesian grid for a given coordinate system into file. If the data is a compound data type, then it is given as distinct homogeneous arrays in memory.

Parameters

coordinate_system

The coordinate system. May be NULL to refer to a standard chart.

Returns

A new F5Path pointer. Call F5close() if it is no longer used.

References F5close(), and F5Rcreate_uniform_cartesian3D().

F5Rcreate_uniform()

F5_API F5Path* F5Rcreate_uniform	(	hid_t	File_id,
		double	time,
		const char *	gridname,
		const void *	origin,
		const void *	spacing,
		hsize_t *	dims,
		const char *	coordinate_system
	)

Create a regular grid which is uniform in the specified coordinate system.

Parameters

origin	The origin of the grid, must be of the coordinate type that is associated with the coordinate system.
spacing	The distance among neighboring points of the grid, must be of the vector type of the coordinate system, i.e. the coordinate type that stores coordinate differences.
coordinate_system	The coordinate system. May be NULL to refer to the standard cartesian chart.

Returns

A new F5Path pointer. Call F5close() if it is no longer used.

F5Rcreate_uniform_cartesian3D()

F5_API F5Path* F5Rcreate_uniform_cartesian3D	(	hid_t	file_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	origin,
		const F5_vec3_float_t *	spacing,
		hsize_t	dims[3],
		const char *	coordinate_system
	)

Create a regular three-dimensional grid which is uniform in the specified coordinate system.

Parameters

coordinate_system

The coordinate system. May be NULL to refer to a standard chart.

Returns

A new F5Path pointer. Call F5close() if it is no longer used.

References F5Fclose(), F5Fwrite_linear(), and F5Rcreate_cartesian_3D().

Referenced by F5Fwrite_uniform_cartesian3D(), F5Fwrite_uniform_cartesian3Ds(), F5write_uniform_cartesian3Dv(), and F5write_uniform_cartesian3Dvs().

F5write_uniform_cartesian3Dv()

F5_API int F5write_uniform_cartesian3Dv	(	hid_t	file_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	origin,
		const F5_vec3_float_t *	spacing,
		hsize_t	dims[3],
		const char *	coordinate_system,
		hid_t	property_id,
			...
	)

Write a bunch of data fields given on the same uniform cartesian grid. This variation of the uniform grid writer function uses a variable number of arguments list. Each field is defined by a triple of

  const char *fieldname
  hid_t fieldtype
  const void  *dataPtr

If either the fieldname or the dataPtr are NULL, then the traversal of the argument is terminated.

Parameters

coordinate_system

The coordinate system. May be NULL to refer to a standard chart.

Returns

The number of successfully written fields.

References F5close(), F5Fwrite(), and F5Rcreate_uniform_cartesian3D().

F5write_uniform_cartesian3Dvs()

F5_API int F5write_uniform_cartesian3Dvs	(	hid_t	file_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	origin,
		const F5_vec3_float_t *	spacing,
		hsize_t	dims[3],
		const char *	coordinate_system,
		hid_t	property_id,
			...
	)

Write a bunch of data fields given on the same uniform cartesian grid. This variation of the uniform grid writer function uses a variable number of arguments list. Each field is defined by a triple of

  const char *fieldname
  hid_t fieldtype
  const void **dataPtr

If either the fieldname or the dataPtr are NULL, then the traversal of the argument is terminated.

Parameters

coordinate_system

The coordinate system. May be NULL to refer to a standard chart.

Returns

The number of successfully written fields.

References F5close(), and F5Rcreate_uniform_cartesian3D().