Particle Systems

Functions
F5_API F5ErrorCode	F5write_particle_positions (hid_t fileID, double time, const char *name, const F5_vec3_point_t *Coords, int nCoords, const char *coordinate_system)
F5_API int	F5write_particle_cartesian3Dv (hid_t file_id, double time, const char *gridname, const F5_vec3_point_t *Coords, int nCoords, const char *coordinate_system,...)
F5_API int	F5write_particle_double_cartesian3Dv (hid_t File_id, double time, const char *gridname, const F5_point3_double_t *Coords, int nCoords, const char *coordinate_system,...)
F5_API int	F5write_particle_cartesian3DvU (hid_t File_id, double time, const char *gridname, const F5_vec3_point_t *Coords, const char *CoordUnit, int nCoords, const char *coordinate_system,...)
F5_API void	F5write_particle_positions_with_field_d (hid_t fileID, double time, const char *name, const F5_vec3_point_t *Coords, int nCoords, const double *data)
F5_API void	F5write_polar_particle_positions (hid_t fileID, double time, const char *name, const F5_polar_point3_float_t *Coords, int nCoords)
F5_API void	F5write_particle_positions3fv (hid_t fileID, double time, const char *name, const float *x, const float *y, const float *z, int nCoords)

Detailed Description

Function Documentation

F5write_particle_cartesian3Dv()

F5_API int F5write_particle_cartesian3Dv	(	hid_t	File_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	Coords,
		int	nCoords,
		const char *	coordinate_system,
			...
	)

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.

Creates a grid object of a point cloud (vertices) and additional fields. Additional fields can be added in the ellipses ( ... ) by specifying the field name, the data type and the pointer to the data array: e.g.: ( ... ,"Velocity", F5T_VEC3_FLOAT, V, ,"Acceleration", F5T_VEC3_FLOAT, A, ... )

References F5close(), F5Lwrite1D(), F5Rcreate_cartesian_nD(), F5Path::Field_hid, and F5Path::Representation_hid.

F5write_particle_cartesian3DvU()

F5_API int F5write_particle_cartesian3DvU	(	hid_t	File_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	Coords,
		const char *	CoordUnit,
		int	nCoords,
		const char *	coordinate_system,
			...
	)

added unit support in convenience function

References F5close(), F5Dappend(), F5Lwrite1D(), F5Rcreate_cartesian_nD(), F5Path::Field_hid, F5Path::FileIDs, and F5Path::Representation_hid.

F5write_particle_positions()

F5_API F5ErrorCode F5write_particle_positions	(	hid_t	fileID,
		double	time,
		const char *	name,
		const F5_vec3_point_t *	Coords,
		int	nCoords,
		const char *	coordinate_system
	)

Write positions of some particles to the Fiber HDF5 file.

Parameters

fileID	Some HDF5 id corresponding to some already opened HDF5 file.
time	The physical time for this data set.
name	Some textual description of this particle set; should be simple (avoid spaces, special characters and extensively long names). It is used to identify surfaces over multiple timesteps, so must be identical for subsequent calls on evolving surfaces.
Coords	The cartesian coordinates of the points
nCoords	How many points are there
coordinate_system	The coordinate system. May be NULL to refer to a standard chart.

References F5close(), and F5Rcreate_cartesian_nD().

F5write_particle_positions3fv()

F5_API void F5write_particle_positions3fv	(	hid_t	fileID,
		double	time,
		const char *	name,
		const float *	x,
		const float *	y,
		const float *	z,
		int	nCoords
	)

Like F5write_particle_positions(), but particle positions are given in separate memory arrays.

Todo:

Implement.

Note

Naming convention is inspired by OpenGL

Todo:

use newer field interface

F5write_particle_positions_with_field_d()

F5_API void F5write_particle_positions_with_field_d	(	hid_t	fileID,
		double	time,
		const char *	name,
		const F5_vec3_point_t *	Coords,
		int	nCoords,
		const double *	data
	)

Write particle field with data given on each element.

Todo:

Implement

use newer field interface

F5write_polar_particle_positions()

F5_API void F5write_polar_particle_positions	(	hid_t	fileID,
		double	time,
		const char *	name,
		const F5_polar_point3_float_t *	Coords,
		int	nCoords
	)

Write particle position in polar coordinates.

Todo:

Implement.