F5L.h File Reference

#include "hdf5inc.h"
#include "F5WinDLLApi.h"
#include "F5defs.h"

Go to the source code of this file.

Macros
#define	F5P_DEFAULT   (-1)

Functions
F5_API hid_t	F5Lcreate (hid_t R_id, const char *fieldname, int dimension, const hsize_t *dims, hid_t fieldtype, hid_t property_id)
F5_API hid_t	F5LTcreate_topology (hid_t Grid_hid, const char *TopologyName, int IndexDepth, int SkeletonDimensionality, int DataspaceDimensionality, const hsize_t *refinement)
F5_API int	F5LTset_maximal_grid_refinement (hid_t ContentsGroup_id, const char *gridname, int IndexDepth, int Dimensionality, const hsize_t *refinement)
F5_API int	F5LTget_maximal_grid_refinement (hid_t ContentsGroup_id, const char *gridname, hsize_t *refinement)
F5_API int	F5LTget_maximal_skeleton_refinement (hid_t ContentsGroup_id, const char *gridname, hsize_t *refinement, int IndexDepth, int Dimensionality)
F5_API int	F5LTget_index_depth (hid_t Top_hid)
F5_API hid_t	F5Lwrite (hid_t R_id, const char *fieldname, int dimension, const hsize_t *dims, hid_t fieldtype, hid_t memtype, const void *dataPtr, hid_t enum_type, hid_t property_id)
F5_API hid_t	F5LwriteS (hid_t Container_id, const char *name, int dimension, const hsize_t *dims, hid_t fieldtype, hid_t memtype, const void *dataPtr, hid_t enum_type, hid_t dcpl_id)
F5_API int	F5LreadS (hid_t Container_id, hid_t memtype, void *dataPtr, hid_t ElementLoadID)
F5_API hid_t	F5Lwrite_fraction (hid_t R_id, const char *fieldname, int dimension, const hsize_t *full_dims, const hsize_t *datasize, hid_t fieldtype, hid_t memtype, const void *dataPtr, const hsize_t *datastart, const hsize_t *start_border, const hsize_t *end_border, const char *fraction_name, hid_t enum_type, hid_t property_id)
F5_API hid_t	F5Lwrite_fractionS (hid_t R_id, const char *fieldname, int dimension, const hsize_t *full_dims, const hsize_t *datasize, hid_t fieldtype, hid_t memtype, const void *dataPtr, const hsize_t *datastart, const hsize_t *start_border, const hsize_t *end_border, const char *fraction_name, hid_t enum_type, hid_t property_id)
F5_API hid_t	F5Lwrite_fraction_external (hid_t R_id, const char *fieldname, const char *target_file_name, const char *target_obj_name, const char *prefix, int rank, const hsize_t *full_dims, const hsize_t *datasize, hid_t fieldtype, hid_t memtype, const void *dataPtr, const hsize_t *datastart, const hsize_t *start_border, const hsize_t *end_border, const char *fraction_name, hid_t enum_type, hid_t property_id)
F5_API hid_t	F5LSwrite_fraction (hid_t R_id, const char *fieldname, int dimension, const hsize_t *full_dims, const hsize_t *datasize, hid_t fieldtype, hid_t memtype, const void *const *dataPtr, const hsize_t *datastart, const hsize_t *start_border, const hsize_t *end_border, const char *fraction_name, hid_t enum_type, hid_t property_id)
F5_API hid_t	F5Lwrite1D (hid_t R_id, const char *fieldname, hsize_t nElements, hid_t fieldtype, hid_t memtype, const void *dataPtr, hid_t enum_type, hid_t property_id)
F5_API hid_t	F5Lwrite_linear (hid_t R_id, const char *fieldname, int dimension, const hsize_t *dataspace_dims, hid_t fieldtype, const void *base, const void *delta)
F5_API int	F5Lis_linear (hid_t Rep_id, const char *fieldname)
F5_API hid_t	F5Lread_linear (hid_t F_id, hsize_t *dims, hid_t fieldtype, void *base, void *delta)
F5_API hid_t	F5Lwrite_entity (hid_t R_id, const char *fieldname, hid_t fieldtype, const void *value)
F5_API hid_t	F5Lwrites (hid_t F_id, const char *fieldname, int dimension, const hsize_t *dims, hid_t fieldtype, hid_t memtype, const void *const *dataPtr, hid_t enum_type, hid_t property_id)
F5_API hid_t	F5LwriteX (hid_t R_id, const char *fieldname, int Mrank, const hsize_t dims[], hid_t fieldtype, hid_t memtype, const void *const dataPtr[], const int polynom_order[], const int component_map[], hid_t property_id, hid_t ProcIDLocation)
F5_API hid_t	F5Lget_type (hid_t Field_hid, int FieldIDisGroup, hid_t elink_fapl_id)
F5_API int	F5Lget_field_dimension_and_type (hid_t Representation_hid, const char *fieldname, hsize_t dims[FIBER_MAX_RANK], hid_t *type_id)
F5_API int	F5LAsave_dimensions (hid_t Field_id, const char *aname, int rank, const hsize_t *dims)
F5_API int	F5LAget_dimensions (hid_t Field_id, const char *aname, hsize_t dims[FIBER_MAX_RANK])
F5_API int	F5Lset_space (hid_t Field_id, int rank, const hsize_t *dims)
F5_API int	F5Dset_type_attribute (hid_t F_id, hid_t fieldtype)
F5_API hid_t	F5Lget_space (hid_t Field_id)
F5_API int	F5Lget_compound_extent_dims (hid_t CompoundGroupID, hsize_t *dims)
F5_API hid_t	F5Lget_compound_space (hid_t CompoundGroupID)

Macro Definition Documentation

F5P_DEFAULT

#define F5P_DEFAULT   (-1)

Examples

ADCIRCtoF5.cpp, SchwarzschildF5.c, and mm5-nc2F5.c.

Definition at line 20 of file F5L.h.

Referenced by F5Cwrite_triangular_surface_vc(), and F5Flink_triangular_surface().

Function Documentation

F5Dset_type_attribute()

F5_API int F5Dset_type_attribute	(	hid_t	F_id,
		hid_t	fieldtype )

Add an attribute to the given group that designates this group as storing multiple components of some compound data types.

Definition at line 1052 of file F5L.c.

{
hid_t   TypeAttrDS_hid;
hid_t   TypeAttr_hid;
herr_t  herr;
void    *buf;
 
        TypeAttr_hid = F5Atry_to_open( F_id, FIBER_HDF5_TYPEID_ATTRIB );
        if (TypeAttr_hid>0)
        {
                F5printf(5, "F5 Warning: F5Dset_type_attribute(): type already exists!\n");
                H5Aclose(TypeAttr_hid);
                return -1;
        }
 
        TypeAttrDS_hid = H5Screate(H5S_SCALAR);
        TypeAttr_hid = H5Acreate2(F_id, FIBER_HDF5_TYPEID_ATTRIB, fieldtype, TypeAttrDS_hid,
                                  H5P_DEFAULT, H5P_DEFAULT);
        if (TypeAttr_hid<0)
        {
                F5printf(1, "F5Dset_type_attribute::H5Acreate() failed.");
                H5Sclose(TypeAttrDS_hid);
                return -3;
        }
 
        buf = calloc( H5Tget_size(fieldtype), 1);
        herr = H5Awrite(TypeAttr_hid, fieldtype, buf);
        if (herr<0)  F5printf(1, "F5Dset_type_attribute::H5Awrite() failed.");
        H5Sclose(TypeAttrDS_hid);
        H5Aclose(TypeAttr_hid);
        free(buf);
 
        if (!F5Tcheck_committed(fieldtype))
                F5printf(0, "F5 Warning: F5Dset_type_attribute(): compound type not committed!\n");
 
        return  0;
}

References F5Atry_to_open(), F5printf, F5Tcheck_committed(), FIBER_HDF5_TYPEID_ATTRIB, and free().

Referenced by F5Fwrite_fraction(), F5Fwrite_fractionS(), F5FwriteIMAGE(), F5LSwrite_fraction(), F5LwriteS(), F5Lwrites(), and F5LwriteX().

F5Lget_space()

F5_API hid_t F5Lget_space

(

hid_t

Field_id

)

Get the dataspace of an F5 field. The field id may be a group or a dataset ID. If it has an dimensions attribute, then this one is taken for dataspace information. Otherwise, the dataspace of the dataset is used. If it's not a dataset and does not have a dimension attribute, then it's an error.

Definition at line 250 of file F5L.c.

{
hid_t   space_id, attr_id;
int     rank = -1, i, Dims[FIBER_MAX_RANK];
hsize_t dims[FIBER_MAX_RANK];
 
        F5printf(40, "-- F5Lget_space(): Determine skeleton topology.");
 
        H5E_BEGIN_TRY
        attr_id  = F5Aopen_name(Field_id, FIBER_FIELD_DATASPACE_DIMENSIONS_ATTRIBUTE);
        H5E_END_TRY
 
        if (attr_id>0)
        {
        hsize_t TotalNumber = 1;
 
                space_id = H5Aget_space(attr_id);
                rank      = H5Sget_simple_extent_npoints(space_id);
 
                F_H5Aread(attr_id, H5T_NATIVE_INT, Dims, FIBER_FIELD_DATASPACE_DIMENSIONS_ATTRIBUTE);
                H5Aclose(attr_id);
                H5Sclose(space_id);
 
                for(i=0; i<rank; i++)
                {
                        dims[i] = Dims[i];
                        TotalNumber *= dims[i];
                }
                if (TotalNumber==0) /* no known regular topology here */
                {
                        F5printf(20, "  F5Lget_space(): Unknown topology, might be complex.");
                        return -1;
                }
 
                space_id = H5Screate_simple(rank, dims, dims);
                return space_id;
        }
 
        space_id = H5Dget_space(Field_id);
        return space_id;
}

References F5Aopen_name(), F5printf, F_H5Aread(), FIBER_FIELD_DATASPACE_DIMENSIONS_ATTRIBUTE, and FIBER_MAX_RANK.

F5Lis_linear()

F5_API int F5Lis_linear	(	hid_t	Rep_id,
		const char *	fieldname )

Definition at line 985 of file F5L.c.

{
hid_t   attr_id, F_id;
 
        H5E_BEGIN_TRY
        F_id = H5Gopen2(Rep_id, fieldname, H5P_DEFAULT);
        H5E_END_TRY
 
        if (F_id<0)
                return 0;
 
        H5E_BEGIN_TRY
        attr_id  = F5Aopen_name(F_id, FIBER_UNIFORMARRAY_BASE_ATTRIBUTE);
        H5E_END_TRY
 
        if (attr_id<0)
        {
                puts("no "FIBER_UNIFORMARRAY_BASE_ATTRIBUTE" attribute!");
                H5Gclose( F_id );
                return 0;
        }
        H5Aclose(attr_id);
 
        H5E_BEGIN_TRY
        attr_id  = F5Aopen_name(F_id, FIBER_UNIFORMARRAY_DELTA_ATTRIBUTE);
        H5E_END_TRY
 
        if (attr_id<0)
        {
                H5Gclose( F_id );
                return 0;
        }
        H5Aclose(attr_id);
        H5Gclose( F_id );
 
        return 1;
}

References F5Aopen_name(), FIBER_UNIFORMARRAY_BASE_ATTRIBUTE, FIBER_UNIFORMARRAY_DELTA_ATTRIBUTE, and H5Gclose.

Referenced by F5Fis_linear(), F5P_is_rectilinear(), and F5P_is_uniform().

F5Lwrite_fraction_external()

F5_API hid_t F5Lwrite_fraction_external	(	hid_t	R_id,
		const char *	fieldname,
		const char *	target_file_name,
		const char *	target_obj_name,
		const char *	prefix,
		int	rank,
		const hsize_t *	full_dims,
		const hsize_t *	datasize,
		hid_t	fieldtype,
		hid_t	memtype,
		const void *	dataPtr,
		const hsize_t *	datastart,
		const hsize_t *	start_border,
		const hsize_t *	end_border,
		const char *	fraction_name,
		hid_t	enum_type,
		hid_t	property_id )

Definition at line 738 of file F5L.c.

{
hid_t   F_id, B_id;
 
        F5printf(20, "F5Lwrite_fraction(rank=%d)", rank);
        if (rank==3)
                F5printf(20, "F5Lwrite_fraction(%lux%lux%lu)",
                                (long)datasize[0], (long)datasize[1], (long)datasize[2]);
 
        F_id = F5Gappend_external(R_id, fieldname, target_file_name, target_obj_name, prefix );
        if (F_id<0)
        {
                F5printf(20, "F5Lwrite_fraction_external() - FAILED to create external field fragment.");
                return F_id;
        }
 
        {
        char    myBlockname[ MAX_BLOCKNAME ];
        B_id = F5Lwrite(F_id, fraction_name?fraction_name:blockname(myBlockname, rank, datastart),
                        rank, datasize, fieldtype, memtype, dataPtr, enum_type, property_id);
 
                if (B_id<=0)
                {
                        F5printf(1, "F5Lwrite_fraction_external() - FAILED to append field fragment data.");
                        F5Xclose(F_id);
                        return B_id;
                }
        }
        if (full_dims)
                F5Lset_space(F_id, rank, full_dims);
 
        F5LAsave_dimensions(B_id, FIBER_FRAGMENT_OFFSET_ATTRIBUTE, rank, datastart);
 
        if (start_border)
                F5LAsave_dimensions(B_id, FIBER_FRAGMENT_NOOVERLAP_START_ATTRIBUTE, rank, start_border);
 
        if (end_border)
                F5LAsave_dimensions(B_id, FIBER_FRAGMENT_NOOVERLAP_END_ATTRIBUTE, rank, end_border);
 
        F5Xclose(B_id);
        return F_id;
}

References F5Gappend_external(), F5LAsave_dimensions(), F5Lset_space(), F5Lwrite(), F5printf, F5Xclose(), FIBER_FRAGMENT_NOOVERLAP_END_ATTRIBUTE, FIBER_FRAGMENT_NOOVERLAP_START_ATTRIBUTE, FIBER_FRAGMENT_OFFSET_ATTRIBUTE, and MAX_BLOCKNAME.

Referenced by F5Fwrite_fraction_external().

F5Lwrite_fractionS()

F5_API hid_t F5Lwrite_fractionS	(	hid_t	R_id,
		const char *	fieldname,
		int	dimension,
		const hsize_t *	full_dims,
		const hsize_t *	datasize,
		hid_t	fieldtype,
		hid_t	memtype,
		const void *	dataPtr,
		const hsize_t *	datastart,
		const hsize_t *	start_border,
		const hsize_t *	end_border,
		const char *	fraction_name,
		hid_t	enum_type,
		hid_t	property_id )

Write a contiguious compound data set as separated compound data into the file, which involves data transformation.

Calls F5LwriteS().

Definition at line 691 of file F5L.c.

{
hid_t   F_id, B_id;
 
        F5printf(-1, "F5Lwrite_fractionS(rank=%d)", rank);
 
        F_id = F5Gappend(R_id,  fieldname);
        if (F_id<0)
        {
                F5printf(1, "F5Lwrite_fractionS() - FAILED to append field fragment group.");
                return F_id;
        }
        {
        char    myBlockname[MAX_BLOCKNAME];
        B_id = F5LwriteS(F_id, fraction_name?fraction_name:blockname(myBlockname, rank, datastart),
                         rank, datasize, fieldtype, memtype, dataPtr, enum_type, property_id);
        }
        if (B_id<0)
        {
                F5printf(1, "F5Lwrite_fractionS() - FAILED to append field fragment data.");
                F5Xclose(F_id);
                return B_id;
        }
 
        if (full_dims)
                F5Lset_space(F_id, rank, full_dims);
 
        F5LAsave_dimensions(B_id, FIBER_FRAGMENT_OFFSET_ATTRIBUTE, rank, datastart);
 
        if (start_border)
                F5LAsave_dimensions(B_id, FIBER_FRAGMENT_NOOVERLAP_START_ATTRIBUTE, rank, start_border);
 
        if (end_border)
                F5LAsave_dimensions(B_id, FIBER_FRAGMENT_NOOVERLAP_END_ATTRIBUTE, rank, end_border);
 
        F5Xclose(B_id);
        return F_id;
}

References F5Gappend(), F5LAsave_dimensions(), F5Lset_space(), F5LwriteS(), F5printf, F5Xclose(), FIBER_FRAGMENT_NOOVERLAP_END_ATTRIBUTE, FIBER_FRAGMENT_NOOVERLAP_START_ATTRIBUTE, FIBER_FRAGMENT_OFFSET_ATTRIBUTE, and MAX_BLOCKNAME.

Referenced by F5Fwrite_fractionS().

F5LwriteX()

F5_API hid_t F5LwriteX	(	hid_t	R_id,
		const char *	fieldname,
		int	Mrank,
		const hsize_t	dims[],
		hid_t	fieldtype,
		hid_t	memtype,
		const void *const	dataPtr[],
		const int	polynom_order[],
		const int	component_map[],
		hid_t	property_id,
		hid_t	ProcIDLocation )

Write a field as an n-dimensional direct product, where each dimensional extend is given as an explicit dataset or a polynom. Used e.g. for as rectilinear coordinates, uniform coordinates or "stacked" coordinates.

Parameters

rank	The rank n (dimensionality) of the dataset.
dims	The extent (size) of the dataset in each dimension.
fieldtype	The type of the dataset; it must be a compound type with n members.
memtype	The type of the dataset how it resides in memory; it must be a compound type with n members where the ith member must be convertible to the field type's ith member.
polynom_order	For each dimension, provides the order of the respective polynom. If it is negative, then the respective coordinate is interpreted as given explicitely by a dataset containing each point and the extent is taken from the dims parameter.
property_id	Data creation properties, may be F5P_DEFAULT.
ProcIDLocation	Group ID where the enumeration type is stored in the file.

Note

The component order of the field and memory type do not need to be identical, i.e. the field type may be {x,y,z}, while the memory type specifies {z,y,x}. The data are accessed in memory according to the memory type, but written into the file in the order as specified by the field type.

References F5_API, and FIBER_MAX_RANK.