Regular Grids

Modules
	Uniform Grids

Functions
F5_API F5Path *	F5Rcreate_rectilinear (hid_t File_id, double time, const char *gridname, const void *origin, const void *spacing, hsize_t *dims, const char *coordinate_system, hid_t property_id,...)
F5_API int	F5get_extension (F5Path *grid, hsize_t dims[FIBER_MAX_RANK])
F5_API F5Path *	F5Rcreate_rectilinear_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, hid_t property_id, float *x, float *y, float *z)
F5Path *	F5Rcreate_curvilinear_cartesian3D (hid_t File_id, double time, const char *gridname, const F5_vec3_point_t *coords, hsize_t dims[3], const char *coordinate_system, hid_t property_id)

Detailed Description

Function Documentation

F5Rcreate_curvilinear_cartesian3D()

F5Path* F5Rcreate_curvilinear_cartesian3D	(	hid_t	File_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	coords,
		hsize_t	dims[3],
		const char *	coordinate_system,
		hid_t	property_id
	)

Create a regular grid with curvilinear coordinates.

See also

F5create_uniform_cartesian3D(),F5create_rectilinear()

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

F5Rcreate_rectilinear()

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

Create a representation that is rectilinear, uniform or stacked in the given 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.
property_id	HDF5 property for storing the coordinate arrays in the file, e.g. chunked and/or compressed. May be F5P_DEFAULT. The property will be used to create 1D arrays. The coordinate arrays are usually small compared to the field data. Therefore, the default should be fine for all cases.
...	The argument list is to be succeeded by a list of data pointers, each of them pointing to a one-dimensional array of data values. One array per coordinate needs to be specified (but may be NULL), with exactly the same type as in the coordinate system's point type.

Note

Memory to File type conversion is not supported yet!

Should better be named "save_rectilinear", since this function writes data to disc, not only creates dataset entries.

References F5close(), F5Fclose(), F5Fwrite_linear(), F5Lwrite1D(), F5Rcreate_cartesian_3D(), F5Path::Field_hid, F5Path::myChart, _F5_ChartPrecisionTypes::Point_hid_t, and ChartDomain_IDs::SinglePrecision.

Referenced by F5Rcreate_rectilinear_cartesian3D().

F5Rcreate_rectilinear_cartesian3D()

F5_API F5Path* F5Rcreate_rectilinear_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,
		hid_t	property_id,
		float *	x,
		float *	y,
		float *	z
	)

Create a regular grid with rectilinear or stacked coordinates. If the one-dimensional coordinate arrays are omitted, then a linear mapping based on the origin and spacing parameters is assumed. If all coordinate arrays are given, then the origin and spacing information is not used. Otherwise, if none of the coordinate arrays is given, then the coordinates will be uniform.

See also

F5create_uniform_cartesian3D(),F5create_rectilinear()

Parameters

x	Coordinate values in x direction, may be NULL.
y	Coordinate values in y direction, may be NULL.
z	Coordinate values in z direction, may be NULL.

References F5Rcreate_rectilinear().