Regular Grids

Topics
	Uniform Grids

Functions
F5_API F5Path *	F5Rcreate_rectilinear (hid_t File_id, double time, const char *gridname, const void *origin, const void *spacing, hsize_t *dims, const char *coordinate_system, hid_t property_id,...)
F5_API int	F5get_extension (F5Path *grid, hsize_t dims[FIBER_MAX_RANK])
F5_API F5Path *	F5Rcreate_rectilinear_cartesian3D (hid_t File_id, double time, const char *gridname, const F5_vec3_point_t *origin, const F5_vec3_float_t *spacing, hsize_t dims[3], const char *coordinate_system, hid_t property_id, float *x, float *y, float *z)
F5Path *	F5Rcreate_curvilinear_cartesian3D (hid_t File_id, double time, const char *gridname, const F5_vec3_point_t *coords, hsize_t dims[3], const char *coordinate_system, hid_t property_id)

Detailed Description

Function Documentation

F5get_extension()

F5_API int F5get_extension	(	F5Path *	grid,
		hsize_t	dims[FIBER_MAX_RANK] )

Definition at line 522 of file F5uniform.c.

{
hid_t   Top_id;
struct Dims data;
        data.grid = grid;
 
        if (!grid->Grid_hid)
                return -1;
 
        if (grid->Topology_hid)
                Top_id = grid->Topology_hid;
        else
                Top_id = H5Gopen2(grid->Grid_hid, FIBER_HDF5_POINTS, H5P_DEFAULT);
 
        data.dims = dims;
        H5Giterate(Top_id, ".", NULL, search_extension, &data);
 
        if (!grid->Topology_hid)
                H5Gclose( Top_id );
 
        return data.rank;
}

References Dims::dims, FIBER_HDF5_POINTS, FIBER_MAX_RANK, Dims::grid, F5Path::Grid_hid, H5Gclose, Dims::rank, and F5Path::Topology_hid.

Referenced by F5P_is_curvilinear(), F5P_is_particle_system(), and F5P_is_regular3D().

F5Rcreate_curvilinear_cartesian3D()

F5Path * F5Rcreate_curvilinear_cartesian3D	(	hid_t	File_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	coords,
		hsize_t	dims[3],
		const char *	coordinate_system,
		hid_t	property_id )

Create a regular grid with curvilinear coordinates.

See also

F5create_uniform_cartesian3D(),F5create_rectilinear()

Definition at line 147 of file F5uniform.c.

{
F5Path*f = F5Rcreate_cartesian_3D(File_id, time, gridname, coordinate_system);
 
        F5Fwrite(f, FIBER_HDF5_POSITIONS_STRING,
                 3, dims, F5T_COORD3_FLOAT, 0, coords, property_id);
 
        F5Fclose(f);
 
        return f;
}

References F5Fclose(), F5Fwrite(), F5Rcreate_cartesian_3D(), F5T_COORD3_FLOAT, and FIBER_HDF5_POSITIONS_STRING.

F5Rcreate_rectilinear()

F5_API F5Path * F5Rcreate_rectilinear	(	hid_t	File_id,
		double	time,
		const char *	gridname,
		const void *	origin,
		const void *	spacing,
		hsize_t *	dims,
		const char *	coordinate_system,
		hid_t	property_id,
			... )

Create a representation that is rectilinear, uniform or stacked in the given coordinate system.

Parameters

origin	The origin of the grid, must be of the coordinate type that is associated with the coordinate system.
spacing	The distance among neighboring points of the grid, must be of the vector type of the coordinate system, i.e. the coordinate type that stores coordinate differences.
coordinate_system	The coordinate system. May be NULL to refer to the standard cartesian chart.
property_id	HDF5 property for storing the coordinate arrays in the file, e.g. chunked and/or compressed. May be F5P_DEFAULT. The property will be used to create 1D arrays. The coordinate arrays are usually small compared to the field data. Therefore, the default should be fine for all cases.
...	The argument list is to be succeeded by a list of data pointers, each of them pointing to a one-dimensional array of data values. One array per coordinate needs to be specified (but may be NULL), with exactly the same type as in the coordinate system's point type.

Note

Memory to File type conversion is not supported yet!

Should better be named "save_rectilinear", since this function writes data to disc, not only creates dataset entries.

Definition at line 169 of file F5uniform.c.

{
int     i, component_count;
F5Path*f = F5Rcreate_cartesian_3D(File_id, time, gridname, coordinate_system);
 
hid_t   Point_hid_t = f->myChart->SinglePrecision.Point_hid_t;
int     nDims    = H5Tget_nmembers(Point_hid_t);
va_list vl;
 
        if (!F5Fwrite_linear(f, FIBER_HDF5_POSITIONS_STRING,
                             nDims, dims, Point_hid_t, origin, spacing))
        {
                F5close(f);
                return NULL;
        }
 
        /* Init the step through the argument list */
        va_start(vl, property_id);
 
        component_count = 0;
        for(i=0; i<nDims; i++)
        {
        hsize_t length = dims[i];
        const void*dataPtr = va_arg(vl, const void*);
        hid_t   component_id;
        char * name;
        hid_t   member_type;
 
                if (!dataPtr) continue;
                component_count++;
 
                name = H5Tget_member_name(Point_hid_t, i);
 
                member_type = H5Tget_member_type(Point_hid_t, i);
 
                component_id = F5Lwrite1D(f->Field_hid, name, length, member_type, 0, dataPtr,
                                          F5LTmake_enum_type(f), property_id);
                H5Dclose(component_id);
                H5Tclose(member_type);
                free(name);
        } 
 
        F5I_add_field(f, FIBER_HDF5_POSITIONS_STRING);
 
/*
        if (nDims==2)
                F5I_add_grid(f, gridname, time, HAVE_REGULAR_CELLS2D);
        else if (nDims==3)
                F5I_add_grid(f, gridname, time, HAVE_REGULAR_CELLS3D);
 
        if (component_count == nDims)
                F5I_add_grid(f, gridname, time, HAVE_CARTESIAN_RECTILINEAR_POSITIONS);
        else if (component_count == 0)
                F5I_add_grid(f, gridname, time, HAVE_CARTESIAN_UNIFORM_POSITIONS);
        else
                F5I_add_grid(f, gridname, time, gridtype);
*/
 
        /* Close the Step through */
        va_end(vl);
 
        F5Fclose(f);
 
        return f;
}

References F5close(), F5Fclose(), F5Fwrite_linear(), F5I_add_field(), F5LTmake_enum_type(), F5Lwrite1D(), F5Rcreate_cartesian_3D(), FIBER_HDF5_POSITIONS_STRING, F5Path::Field_hid, free(), H5Tclose(), F5Path::myChart, name, _F5_ChartPrecisionTypes::Point_hid_t, and ChartDomain_IDs::SinglePrecision.

Referenced by F5Rcreate_rectilinear_cartesian3D().

F5Rcreate_rectilinear_cartesian3D()

F5_API F5Path * F5Rcreate_rectilinear_cartesian3D	(	hid_t	File_id,
		double	time,
		const char *	gridname,
		const F5_vec3_point_t *	origin,
		const F5_vec3_float_t *	spacing,
		hsize_t	dims[3],
		const char *	coordinate_system,
		hid_t	property_id,
		float *	x,
		float *	y,
		float *	z )

Create a regular grid with rectilinear or stacked coordinates. If the one-dimensional coordinate arrays are omitted, then a linear mapping based on the origin and spacing parameters is assumed. If all coordinate arrays are given, then the origin and spacing information is not used. Otherwise, if none of the coordinate arrays is given, then the coordinates will be uniform.

See also

F5create_uniform_cartesian3D(),F5create_rectilinear()

Parameters

x	Coordinate values in x direction, may be NULL.
y	Coordinate values in y direction, may be NULL.
z	Coordinate values in z direction, may be NULL.

Definition at line 242 of file F5uniform.c.

{
        F5Path* path = F5Rcreate_rectilinear(File_id, time,
                                     gridname,
                                     origin,
                                     spacing,
                                     dims,
                                     coordinate_system,
                                     property_id,
                                     x,y,z);
    if (path) {
        if (!x && !y && !z) {
            F5Cset (path, FIBER_HDF5_POSITIONS_STRING, FIBER_REGULAR_GRID_URL "StandardCartesian/Uniform/");
        } else if (z && !x && !y) {
            F5Cset (path, FIBER_HDF5_POSITIONS_STRING, FIBER_REGULAR_GRID_URL "StandardCartesian/zStacked/");
        } else {
            F5Cset (path, FIBER_HDF5_POSITIONS_STRING, FIBER_REGULAR_GRID_URL "StandardCartesian/Rectilinear/");
        }
    }
    return path;
}

References F5Cset(), F5Rcreate_rectilinear(), FIBER_HDF5_POSITIONS_STRING, and FIBER_REGULAR_GRID_URL.