F5particles.h

Go to the documentation of this file.

#ifndef __F5particles_H
#define __F5particles_H
 
#include "F5coordinates.h"
#include "F5F.h"
#include "F5WinDLLApi.h"
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
/**\defgroup particles Particle Systems
  */
 
/** @{ */
 
 
/**\ingroup particles
   Write positions of some particles to the Fiber HDF5 file.
 
   @param fileID Some HDF5 id corresponding to some already opened HDF5 file.
   @param time   The physical time for this data set.
   @param 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.
   @param Coords     The cartesian coordinates of the points
   @param nCoords    How many points are there
   @param coordinate_system The coordinate system.
                            May be NULL to refer to a standard chart.
*/
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);
 
/**\ingroup particles
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
<PRE>
  const char *fieldname
  hid_t fieldtype
  const void  *dataPtr
</PRE>
If either the fieldname or the dataPtr are NULL, then the traversal of the
argument is terminated.
 
@param coordinate_system The coordinate system.
                  May be NULL to refer to a standard chart.
 
@return The number of successfully written fields.
 */
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,
                                   ...);
 
                                 /**\ingroup particles
   Write particle field with data given on each element.
   \todo Implement
   \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);
 
 
/**\ingroup particles
   Write particle position in polar coordinates.
   \todo Implement.
 */
F5_API void F5write_polar_particle_positions(hid_t fileID, double time,
                                      const char*name,
                                      const F5_polar_point3_float_t*Coords, int nCoords);
 
/**\ingroup particles
   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_positions3fv(hid_t fileID, double time,
                                   const char*name,
                                   const float*x, const float*y, const float*z,
                                   int nCoords);
 
 
/** @} */
 
 
#ifdef  __cplusplus
}    /* extern "C" */
#endif
 
#endif  /* __F5particles_H */