F5AMR.h

Go to the documentation of this file.

#ifndef __F5AMR_H
#define __F5AMR_H
 
#include "F5types.h"
 
#include "F5WinDLLApi.h"
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
/**\defgroup AMR Adaptive Hierarchical Meshes
  */
 
typedef struct
{
        int spatialRef[3];
        int timeRef;
}
        LevelInfo;
 
typedef struct
{
        hid_t fileID;
        const char*description;
        LevelInfo*li;
        int     nLevels;
}
        AMRInfo;
 
/**\ingroup AMR
   Adds AMR data to an HDF5 file.
 
   @param fileID  An HDF5 id as returned by the H5Fopen() or H5Fcreate() calls.
   @param rank    Dimensionality of the data.
 
   @param rootOrigin  minimal coordinate of root level bounding box
   @param rootDelta   cell-size on root level
   @param description A short description about the data set. It should be short
                      and contain no special characters or spaces. The same rules
                      as for file names apply here. Ie. special characters and long
                      names are possible, but it is better to avoid them.
 
   @return A pointer to an AMRInfo structure, which allows to set further information
           for each AMR level. The per-level information must be set in the structure.
           The result must be released by the F5AMRclose() function.
*/
F5_API AMRInfo*F5AMRopen(hid_t fileID,
                         const int rank,
                         double rootOrigin[3],
                         double rootDelta[3],
                         const char*description);
 
/**\ingroup AMR
   Releases the data structure that had been allocated by the F5AMRopen() call.
 */
F5_API void     F5AMRclose(AMRInfo*);
 
enum
{
       F5AMR_VERTEX_CENTERED  = 0,
       F5AMR_CELL_CENTERED    = 0xFFFFFFFFU,
       F5AMR_X_CENTERED       = 0x00000001,
       F5AMR_Y_CENTERED       = 0x00000002,
       F5AMR_Z_CENTERED       = 0x00000004,
       F5AMR_XY_CENTERED      = F5AMR_X_CENTERED |  F5AMR_Y_CENTERED
};
 
/**\ingroup AMR
   Writes out a single AMR data box.
   The data layout of non-scalar field is an array of struct.
   @param AI        Some AMRInfo data structure which was created by an F5AMROpen() call.
   @param timestep  counted in steps on the highest level of resolution
   @param physTime  associated physical time of this timestep
   @param level     refinement level this box belongs to
   @param dimension The dimensionality of the data.
   @param location  Origin of this grid in coordinates given by the cells on this level,
                    must be consistent with the dimension parameter.
   @param size      Number of elements of data array in each dimension, must be consistent with the dimension parameter.
   @param dataPtr   Pointer to data array, the number of elements must be consistent with the size parameter.
   @param fieldname Some name of the field (density, pressure, ...)
   @param fieldtype HDF5 data type identifier. The caller is responsible for creating a
                    corect HDF5 description of the provided data.
   @param Centering bit array of flags to specify where relative to a uniform cell the data reside.
   @param blockname An (optional) identifier for each block.
   @param property_id An HDF5 dataset property (may specify data chunking, compression etc.). May be F5P_DEFAULT.
*/
F5_API herr_t F5AMRwrite_block( AMRInfo*AI,
                                const int    timestep,
                                const double physTime,
                                const char*  fieldname,
                                const int    level,
                                int          dimension,
                                const int    *location,
                                const int    *size,
                                hid_t fieldtype,
                                const void* dataPtr,
                                int   Centering,
                                const char*blockname,
                                const char*coordinate_system,
                                hid_t property_id);
 
 
/**\ingroup AMR
   Writes out a single AMR data box.
   The data layout of non-scalar field is a struct of arrays,
   ie. the data fields of each component of eg. some vector field resides in
   different scalar arrays.
 
   @param AI        Some AMRInfo data structure which was created by an F5AMROpen() call.
   @param timestep  counted in steps on the highest level of resolution
   @param physTime  associated physical time of this timestep
   @param level     refinement level this box belongs to
   @param dimension The dimensionality of the data.
   @param location  Origin of this grid in coordinates given by the cells on this level,
                    must be consistent with the dimension parameter.
   @param size      Number of elements of data array in each dimension, must be consistent with the dimension parameter.
   @param dataPtr   Array of pointer to data arrays, the number of elements must be consistent with the size parameter.
   @param fieldname Some name of the field (density, pressure, ...)
   @param fieldtype HDF5 data type identifier. The caller is responsible for creating a
                    corect HDF5 description of the provided data.
   @param Centering bit array of flags to specify where relative to a uniform cell the data reside.
   @param blockname An (optional) identifier for each block.
   @param property_id An HDF5 dataset property (may specify data chunking, compression etc.). May be F5P_DEFAULT.
*/
F5_API herr_t F5AMRwrite_block_v( AMRInfo*AI,
                                  const int    timestep,
                                  const double physTime,
                                  const char*  fieldname,
                                  const int    level,
                                  int        dimension,
                                  const int    *location,
                                  const int    *size,
                                  hid_t fieldtype,
                                  const void**dataPtr,
                                  int   Centering,
                                  const char*blockname,
                                  const char*coordinate_system,
                                  hid_t property_id);
 
#ifdef  __cplusplus
}    /* extern "C" */
#endif
 
#endif  /* __F5AMR_H */