F5defs.h

/*
  $Id: F5defs.h,v 1.34 2008/02/22 23:51:25 werner Exp $
*/

#ifndef __F5_DEFINES_H
#define __F5_DEFINES_H "Fiber HDF5 Defines: $Id: F5defs.h,v 1.34 2008/02/22 23:51:25 werner Exp $"

#define FIBER_MAJOR_VERSION                     0
#define FIBER_MINOR_VERSION                     1
#define FIBER_RELEASE_VERSION                   5

#define FIBER_VERSION_ATTRIBUTE_NAME            "version"
#define FIBER_VERSION_URL_LOCATION              "URL"
#define FIBER_VERSION_URL                       "http://www.fiberbundle.net/F5-0.1.5/"

#define FIBER_CONTENTS                          "TableOfContents"
#define FIBER_CONTENT_GRIDS                     "Grids"
#define FIBER_CONTENT_FIELDS                    "Fields"

#define FIBER_FIELDS_TAG                        "Fields"
#define FIBER_CONTENT_TYPE_TAG                  "ContentType"
#define FIBER_CONTENT_TYPE_MAXTAGLEN   511      

#define FIBER_PARAMETER_SPACE                   "Parameters"


#define FIBER_STATIC_DATA                       "StaticData"

#define FIBER_HDF5_TIME_ATTRIB                  "Time"

#define FIBER_HDF5_TIMESTEP_ATTRIB              "TimeStep"

#define FIBER_HDF5_POINTS                       "Points"
#define FIBER_HDF5_CELLS                        "Connectivity"
#define FIBER_HDF5_EDGES                        "Edges"
#define FIBER_HDF5_EDGES_SET                    "EdgesSet"
#define FIBER_HDF5_FACES                        "Faces"
#define FIBER_HDF5_GEOMETRY                     "Geometry"

#define FIBER_HDF5_POSITIONS_STRING             "Positions"


//#define FIBER_HDF5_ECHOS_SET                    "EchosSet"
#define FIBER_HDF5_TIME_POLAR2D_CHART            "TimePolar2D" 
#define WAVEFORMSIZE                             96
#define FIBER_HDF5_POINTSFRAG_PER_LINESFRAG      "PointsFragmentPerLineFragment"
#define FIBER_HDF5_POINTSFRAG                    "PointsFragments"

#define FIBER_HDF5_REFINEMENT_INFO              "Refinement"

#define FIBER_HDF5_DEFAULT_CHART                "StandardCartesianChart3D"
#define FIBER_HDF5_STANDARD_CHART               FIBER_HDF5_DEFAULT_CHART
#define FIBER_HDF5_CARTESIAN_CHART_DOMAIN       "Cartesian3D"

/* do not use this naming, it's the old one and only here
  for backward compatibility...
*/
#define FIBER_HDF5_DEPRECATED_OLD_DEFAULT_CHART         "Standard Cartesian Chart 3D"
#define FIBER_HDF5_DEPRECATED_OLD_CARTESIAN_DOMAIN      "Cartesian 3D"


#define F5_BACKWARD_COMPATIBILITY

#define FIBER_HDF5_DEFAULT_POLAR_CHART          "StandardPolarChart3D"

#define _FIBER_MAX_COORDNAME_LENGTH             256

#ifdef H5S_MAX_RANK
#define FIBER_MAX_RANK                          H5S_MAX_RANK
#else

#define FIBER_MAX_RANK                          32
#endif


#define FIBER_HDF5_GLOBAL_CHARTS                "Charts"
#define FIBER_HDF5_CHARTS_PER_GRID              "Charts"
#define FIBER_HDF5_CHART_TO_GLOBALCHART_REF     "GlobalChart"
#define FIBER_HDF5_GLOBALCHART_COORDINATES      "Coordinates"
#define FIBER_HDF5_CHART_DOMAIN                 "ChartDomain"
#define FIBER_HDF5_REPRESENTER                  "Reference"

/* Attribute for saving the chart's name additionally as an attribute
   for a given chart group. Makes retrieval easier.  */
#define FIBER_HDF5_CHART_NAME                   "NAME"

/* Some unique number per file to identify charts beyond the HDF5 ID,
   this is probably not required. */
#define FIBER_HDF5_CHART_ID                     "ID"


#define FIBER_HDF5_CHART_MEMLAYOUT              "MemoryOrder"

#define FIBER_HDF5_CELLDIMENSIONALITY           "F5::CellDimensionality"

#define FIBER_HDF5_CHART_POINT_TYPE             "Point"
#define FIBER_HDF5_CHART_VECTOR_TYPE            "Vector"
#define FIBER_HDF5_CHART_COVECTOR_TYPE          "Covector"

#define FIBER_HDF5_CHART_BIVECTOR_TYPE          "Bivector"
#define FIBER_HDF5_CHART_BICOVECTOR_TYPE        "Bicovector"
#define FIBER_HDF5_CHART_METRIC_TYPE            "Metric"
#define FIBER_HDF5_CHART_COMETRIC_TYPE          "Cometric"

#define FIBER_HDF5_CHART_TENSOR_TYPE            "indices"

#define FIBER_HDF5_CHART_PSEUDOSCALAR_TYPE      "PseudoScalar"
#define FIBER_HDF5_CHART_PSEUDOCOSCALAR_TYPE    "PseudoCoScalar"


#define FIBER_HDF5_CHART_SINGLE_PRECISION       "SinglePrecision"
#define FIBER_HDF5_CHART_DOUBLE_PRECISION       "DoublePrecision"

#define FIBER_HDF5_TYPEID_ATTRIB                "TypeID"

#define FIBER_HDF5_COMPONENTMAP_ATTRIB          "F5::ComponentMap"
#define FIBER_HDF5_RANK_ATTRIBUTE               "F5::rank"
#define FIBER_HDF5_GRADE_ATTRIBUTE              "F5::grade"

#define FIBER_FIELD_DATASPACE_DIMENSIONS_ATTRIBUTE "DataspaceDims"
/*#define FIBER_FIELD_DIMENSIONS_ATTRIBUTE      "Size"*/
#define FIBER_FIELD_SIZE_ATTRIBUTE              "size"

#define FIBER_UNIFORMARRAY_ELEMENTS_ATTRIBUTE   "extent"
#define FIBER_UNIFORMARRAY_BASE_ATTRIBUTE       "base"
#define FIBER_UNIFORMARRAY_DELTA_ATTRIBUTE      "delta"
/* (note: these two attributes should go away, they are superceded by
   the range attribute) */
#define FIBER_UNIFORMARRAY_MIN_ATTRIBUTE        "min"
#define FIBER_UNIFORMARRAY_MAX_ATTRIBUTE        "max"

/*
   Attribute specifying the offset of an given dataset within
   a saved dataspace.
 */
#define FIBER_FRAGMENT_OFFSET_ATTRIBUTE         "offset"
#define FIBER_FRAGMENT_NOOVERLAP_START_ATTRIBUTE        "NoOverlapStart"
#define FIBER_FRAGMENT_NOOVERLAP_END_ATTRIBUTE          "NoOverlapEnd"

#define FIBER_FIELD_COMPONENT_RANGE             "Range"

#define FIBER_FIELD_COMPONENT_AVERAGE           "Average"

#define FIBER_FIELD_COMPONENT_DEVIATION         "Deviation"


#define FIBER_HDF5_INDEXDEPTH_ATTRIB            "IndexDepth"

#define F5_INVALID_INDEX_DEPTH          -1313

#define F5_MIN_INDEX_DEPTH      -1

#define F5_MAX_INDEX_DEPTH      +6


#define FIBER_HDF5_SKELETON_DIMENSIONALITY_ATTRIB "F5::SkeletonDimensionality"

#define FIBER_HDF5_INVALID_SKELETON_DIMENSIONALITY  -1313


#define FIBER_HDF5_REPRESENTER_REFERENCE        "Reference"

#define FIBER_HDF5_FIELD_INFO                   "FieldInfo"
#define FIBER_HDF5_LINEARMAP_FIELD              "UniformSampling"
#define FIBER_HDF5_REGULAR_FIELD                "Regular"
#define FIBER_HDF5_SIMPLE_FIELD                 "Contiguous"
#define FIBER_HDF5_FRAGMENTED_FIELD             "Fragmented"
#define FIBER_HDF5_DIRECTPRODUCT_FIELD          "DirectProduct"

typedef enum
{
        UnknownArrayType = 0,
        Contiguous = 1,
        SeparatedCompound = 2,
        Constant = 3,
        FragmentedContiguous = 4,
        FragmentedSeparatedCompound = 5,
        DirectProduct = 6,
        IndexPermutation = 7,
        UniformSampling = 8,
        FragmentedUniformSampling = 9

} ArrayType;


typedef enum
{
        UnknownProcArray    = 0,
        ExplicitProcArray   = 1,
        PolynomialProcArray = 2,
        FourierProcArray    = 3, /* not supported */
        ChebychevProcArray  = 4  /* not supported */

} ProceduralArrayType;


#define FIBER_ARRAY_TYPE_ENUM   "TypeInfo"


/* Some Unit definitions */

/* Name of an attribute that contains a metric unit description as string.*/
#define F5_METRIC_UNIT_DESCRIPTION  "F5::Metric_Unit_Description"

/* use ',' as a delimiter in compound types
   e.g: for a 3D point with mixed units of degree and meters: deg,deg,m
 */
#define F5_UNIT_NOT_DEFINED "-"
#define F5_UNIT_METERS "m"
#define F5_UNIT_METERS_PER_SECONDS "m/s"
#define F5_UNIT_METERS_PER_SQSECONDS "m/s^2"
#define F5_UNIT_NEWTON_PER_SQMILLIMETER "N/mm^2"
#define F5_UNIT_NEWTON "N"
#define F5_UNIT_DEGREE "deg"

#if 0
#define ENABLE_F5_CPLUSPLUS
#endif

#endif  /* __F5_DEFINES_H */