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, ... )

Definition at line 38 of file F5particles.c.

{
const char* fieldname;
hid_t fieldtype;
const void* dataPtr;
va_list vl;
int NumOfWrittenFields = 0;
        //const char* unittype;
 
        /* Create the Field */
F5Path*f = F5Rcreate_cartesian_nD(File_id, time, gridname, 0, coordinate_system);
 
        assert(f);
 
hid_t   creator_hid = H5Pcreate(H5P_DATASET_CREATE);
F5ErrorCode rv;
 
        F5printf(20, "F5write_particle_cartesian3Dv(): write positional information");
 
        rv = F5Fwrite_1D( f, FIBER_HDF5_POSITIONS_STRING, nCoords,  F5T_COORD3_FLOAT, F5T_COORD3_FLOAT, Coords, H5P_DEFAULT);
 
        /* Init the step through the argument list */
        va_start(vl, coordinate_system);
 
        F5printf(20, "F5write_particle_cartesian3Dv(): Step through the argument list");
        /* Step through the argument list */
        for(;;)
        {
        hid_t   file_type;
 
                /* Get the Name of the field */
                fieldname = va_arg(vl, const char*);
                if (fieldname == NULL)  break;
 
                /* Get the type of the field */
                fieldtype = va_arg(vl, hid_t);
                /* Get the pointer to the field */
                dataPtr = va_arg(vl, const void*);
                /* Get the unit of the field*/
                //unittype = va_arg(vl, const void*);
                if (dataPtr == NULL) break; 
 
                F5printf(20, "F5write_particle_cartesian3Dv(): write data for field %s", fieldname);
 
                file_type = F5file_type(f, fieldtype);
 
                /* Write the stuff */
 
                /* WHY NOT USE F5Fwrite here?? */
                f->Field_hid = F5Lwrite1D(f->Representation_hid,
                                          fieldname, nCoords, file_type, 0, dataPtr,
                                          F5LTmake_enum_type(f), creator_hid); 
 
                F5I_add_field(f, fieldname);
                H5Dclose(f->Field_hid);
                f->Field_hid = 0;
                NumOfWrittenFields++;
        }
 
        /* Close the Step through */
        va_end(vl);
 
        H5Pclose(creator_hid);
 
        /* Close the field */
        F5close(f);
 
        return NumOfWrittenFields;
}

References F5close(), F5file_type(), F5Fwrite_1D(), F5I_add_field(), F5LTmake_enum_type(), F5Lwrite1D(), F5printf, F5Rcreate_cartesian_nD(), F5T_COORD3_FLOAT, FIBER_HDF5_POSITIONS_STRING, 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

Definition at line 188 of file F5particles.c.

{
        const char* fieldname;
        hid_t fieldtype;
        const void* dataPtr;
        va_list vl;
        int NumOfWrittenFields = 0;
        const char* unittype;
 
 
        /* Create the Field */
F5Path*f = F5Rcreate_cartesian_nD(File_id, time, gridname, 0, coordinate_system);
 
hid_t   creator_hid = H5Pcreate(H5P_DATASET_CREATE);
 
        F5printf(20, "F5write_particle_cartesian3DvU(): write positional information");
        F5Fwrite_1D( f, FIBER_HDF5_POSITIONS_STRING, nCoords,  F5T_COORD3_FLOAT, F5T_COORD3_FLOAT, Coords, H5P_DEFAULT );
 
        F5Fset_metric_unit_description(f, CoordUnit );
 
#if     0
        /* write the positional information.
           yack. should use F5F functions here...!
         */
{
hsize_t dims = nCoords;
hid_t   coord_ds = H5Screate_simple(1, &dims, NULL);
hid_t   id = F5Dappend(f->Representation_hid, FIBER_HDF5_POSITIONS_STRING, f->FileIDs->Point_hid_t, coord_ds, creator_hid);
        H5Dwrite(id, f->FileIDs->Point_hid_t, H5S_ALL, H5S_ALL, H5P_DEFAULT, Coords);
 
        f->Field_hid = id;
        F5I_add_field(f, FIBER_HDF5_POSITIONS_STRING, FIBER_HDF5_SIMPLE_FIELD);
        f->Field_hid = 0;
        H5Dclose(id);
        H5Sclose(coord_ds);
}
#endif
 
        /* Init the step through the argument list */
        va_start(vl, coordinate_system);
 
        F5printf(20, "F5write_particle_cartesian3DvU(): Step through the argument list");
        /* Step through the argument list */
 
        for(;;)
        {
        hid_t   file_type; // MSVC wants it to be at the beginning of the scope
 
                F5printf(20, "F5write_particle_cartesian3DvU(): Step %d", NumOfWrittenFields);
 
 
                /* Get the Name of the field */
                fieldname = va_arg(vl, const char*);
                /* Get the type of the field */
                fieldtype = va_arg(vl, hid_t);
                /* Get the pointer to the field */
                dataPtr = va_arg(vl, const void*);
                /* Get the unit of the field*/ 
                unittype = (const char*)va_arg(vl, const void*);
 
                /* Break? */
                if ( (fieldname == NULL) || (dataPtr == NULL) || unittype == NULL )
                        break;
 
                F5printf(20, "F5write_particle_cartesian3DvU(): write data");
 
                file_type = F5file_type(f, fieldtype);
 
                /* Write the stuff */
 
                /* WHY NOT USE F5Fwrite here?? */
                f->Field_hid = F5Lwrite1D(f->Representation_hid,
                                          fieldname, nCoords, file_type, 0, dataPtr,
                                          F5LTmake_enum_type(f), creator_hid); 
 
                F5I_add_field(f, fieldname);
 
                F5Fset_metric_unit_description(f, unittype );
 
                H5Dclose(f->Field_hid);
 
 
 
                f->Field_hid = 0;
 
                F5printf(20, "F5write_particle_cartesian3DvU():4 fieldid=%d", (int)f->Field_hid );
                NumOfWrittenFields++;
        }
 
        /* Close the Step through */
        va_end(vl);
 
        H5Pclose(creator_hid);
 
        /* Close the field */
        F5close(f);
 
        return NumOfWrittenFields;
}

References F5close(), F5Dappend(), F5file_type(), F5Fset_metric_unit_description(), F5Fwrite_1D(), F5I_add_field(), F5LTmake_enum_type(), F5Lwrite1D(), F5printf, F5Rcreate_cartesian_nD(), F5T_COORD3_FLOAT, FIBER_HDF5_POSITIONS_STRING, F5Path::Field_hid, F5Path::FileIDs, and F5Path::Representation_hid.

F5write_particle_double_cartesian3Dv()

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,
			... )

Definition at line 111 of file F5particles.c.

{
const char* fieldname;
hid_t fieldtype;
const void* dataPtr;
va_list vl;
int NumOfWrittenFields = 0;
        //const char* unittype;
 
        /* Create the Field */
F5Path*f = F5Rcreate_cartesian_nD(File_id, time, gridname, 0, coordinate_system);
 
        assert(f);
 
hid_t   creator_hid = H5Pcreate(H5P_DATASET_CREATE);
F5ErrorCode rv;
 
        F5printf(20, "F5write_particle_cartesian3Dv(): write positional information");
 
        rv = F5Fwrite_1D( f, FIBER_HDF5_POSITIONS_STRING, nCoords,  F5T_COORD3_DOUBLE, F5T_COORD3_DOUBLE, Coords, H5P_DEFAULT);
 
        /* Init the step through the argument list */
        va_start(vl, coordinate_system);
 
        F5printf(20, "F5write_particle_cartesian3Dv(): Step through the argument list");
        /* Step through the argument list */
        for(;;)
        {
        hid_t   file_type;
 
                /* Get the Name of the field */
                fieldname = va_arg(vl, const char*);
                /* Get the type of the field */
                fieldtype = va_arg(vl, hid_t);
                /* Get the pointer to the field */
                dataPtr = va_arg(vl, const void*);
                /* Get the unit of the field*/
                //unittype = va_arg(vl, const void*);
 
                /* Break? */
                if ( (fieldname == NULL) || (dataPtr == NULL) )
                        break;
 
                F5printf(20, "F5write_particle_cartesian3Dv(): write data");
 
                file_type = F5file_type(f, fieldtype);
 
                /* Write the stuff */
 
                /* WHY NOT USE F5Fwrite here?? */
                f->Field_hid = F5Lwrite1D(f->Representation_hid,
                                          fieldname, nCoords, file_type, 0, dataPtr,
                                          F5LTmake_enum_type(f), creator_hid); 
 
                F5I_add_field(f, fieldname);
                H5Dclose(f->Field_hid);
                f->Field_hid = 0;
                NumOfWrittenFields++;
        }
 
        /* Close the Step through */
        va_end(vl);
 
        H5Pclose(creator_hid);
 
        /* Close the field */
        F5close(f);
 
        return NumOfWrittenFields;
}

References F5close(), F5file_type(), F5Fwrite_1D(), F5I_add_field(), F5LTmake_enum_type(), F5Lwrite1D(), F5printf, F5Rcreate_cartesian_nD(), F5T_COORD3_DOUBLE, FIBER_HDF5_POSITIONS_STRING, F5Path::Field_hid, 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.

Definition at line 16 of file F5particles.c.

{
F5Path*f = F5Rcreate_cartesian_nD(File_id, time, gridname, 0, coordinate_system);
        assert(f);
 
F5ErrorCode rv = F5Fwrite_1D( f, FIBER_HDF5_POSITIONS_STRING, nCoords,  F5T_COORD3_FLOAT, F5T_COORD3_FLOAT, Coords, H5P_DEFAULT);
 
        F5close(f);
 
        return rv;
}

References F5close(), F5Fwrite_1D(), F5Rcreate_cartesian_nD(), F5T_COORD3_FLOAT, and FIBER_HDF5_POSITIONS_STRING.

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

References F5_API, and name.

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

References F5_API, and name.

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.

References F5_API, and name.