Functions

Particle Systems

Functions


Function Documentation

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.
Examples:
Particles.c.
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.
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
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

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.