F5P.h

Go to the documentation of this file.

/*/////////////////////////////////////////////////////////////////
//
// $Id: F5P.h,v 1.6 2007/04/02 22:41:12 werner Exp $
//
// $Log: F5P.h,v $
// Revision 1.6  2007/04/02 22:41:12  werner
// Added #defines for the cell domains
// Added attribute for the dimensionality of the cells, in addition to multiplicity
//
// Revision 1.5  2003/11/04 20:14:23  werner
// Corrected include path to avoid header file naming conflict for corrupted include paths.
//
// Revision 1.4  2003/11/04 19:24:10  werner
// Revised version including a table of contents and field info per grid, and
// also telling the grids per field (reverse look). The API has been revised
// somewhat, such that F5F... function are all functions operation on F5Path
// objects with fields defined.
//
// Revision 1.3  2003/06/16 11:00:20  werner
// Changed the iterator functions to use F5Path objects instead of HDF5 ID's.
// This makes encapsulates more of HDF5 and insists more of using F5,
// but makes retrieving the F5 information easier.
// Also changed back the shared data types to nameless types. Thus type
// attributes cannot be determined directly, but when using F5 functions this
// information, e.g. the Memory Order that is associated with a coordinate system
// is available anyway.
//
// Revision 1.2  2003/05/27 11:52:15  zib
// added F5_API stuff to build dll, if you like to build
// a static lib you'll have to define F5_STATIC during every
// build using the headers
//
// Revision 1.1  2003/04/28 19:33:38  werner
// Improved iterator functions, added interface for grid property functions.
//
// Revision 1.3  2001/10/27 15:39:53  werner
// addec cplusplus wrappe.
*/
#ifndef __F5Gproperty_H
#define __F5Gproperty_H
 
#include "hdf5inc.h"
 
#include "F5WinDLLApi.h"
 
#include "F5F.h"
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
/** \defgroup gridproperty Grid Property Functions
*/
 
/** @{ */
 
 
/**
   Prototype for functions determining grid properties.
   @return true if the property is matched, otherwise false.
  */
typedef int F5_gridproperty_t(F5Path*grid, const char*coordinate_system);
 
F5_API int F5P_is_uniform(F5Path*grid, const char*coordinate_system);
F5_API int F5P_is_Zstacked(F5Path*grid, const char*coordinate_system);
F5_API int F5P_is_rectilinear(F5Path*grid, const char*coordinate_system);
F5_API int F5P_is_curvilinear(F5Path*grid, const char*coordinate_system);
 
F5_API int F5P_is_triangular_surface(F5Path*grid, const char*coordinate_system);
F5_API int F5P_is_particle_system(F5Path*grid, const char*coordinate_system);
 
/** Check if the grid has positions in the specified coordinate system */
F5_API int F5P_has_vertices(F5Path*grid, const char*coordinate_system);
/** Check if the grid has some fields in the specified coordinate system */
F5_API int F5P_has_vertex_fields(F5Path*grid, const char*coordinate_system);
/** Check if the grid has some data fields defined on its cells */
F5_API int F5P_has_cell_fields(F5Path*grid, const char*coordinate_system);
 
/** @} */
 
#ifdef  __cplusplus
}    /* extern "C" */
#endif
 
#endif  /* __F5Gproperty_H */