F5coordinates.h

Go to the documentation of this file.

 
#ifndef __F5Bcoordinates_H
#define __F5Bcoordinates_H
 
#include "F5types.h"
#include "F5Bchart.h"
 
#include "F5WinDLLApi.h"
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
/**\defgroup coords Predefined Coordinate Systems and Standard Charts
*/
 
/************* 4D charts ************************/
 
ChartDomain_IDs*F5B_new_global_cartesian_chart4D();
ChartDomain_IDs*F5B_new_global_polar_chart4D();
 
typedef struct  { F5_float_t   t,x,y,z; } F5_vec4f_t;
typedef struct  { F5_double_t  t,x,y,z; } F5_vec4d_t;
 
typedef struct  { F5_float_t   t,x,y,z; } F5_point4f_t;
typedef struct  { F5_double_t  t,x,y,z; } F5_point4d_t;
 
typedef struct  { F5_float_t t,r,phi,theta; } F5_point_polar4f_t;
typedef struct  { F5_double_t t,r,phi,theta; } F5_point_double4f_t;
 
 
/**
   Symmetric 4x4 tensor in cartesian coordinates.
   \note Corresponding HDF5 type is F5T_METRIC44_FLOAT
  */
typedef struct  { F5_float_t  gtt, gtx, gxx, gty, gxy, gyy, gtz, gxz, gyz, gzz; }  F5_metric4f_t;
typedef struct  { F5_double_t  gtt, gtx, gxx, gty, gxy, gyy, gtz, gxz, gyz, gzz; } F5_metric4d_t;
 
#define F5T_COORD4_FLOAT        F5B_standard_cartesian_chart4D()->SinglePrecision.Point_hid_t
#define F5T_COORD4_DOUBLE       F5B_standard_cartesian_chart4D()->DoublePrecision.Point_hid_t
#define F5T_VEC4_FLOAT          F5B_standard_cartesian_chart4D()->SinglePrecision.Vector_hid_t
#define F5T_VEC4_DOUBLE         F5B_standard_cartesian_chart4D()->DoublePrecision.Vector_hid_t
#define F5T_BIVEC4_FLOAT        F5B_standard_cartesian_chart4D()->SinglePrecision.Vector_hid_t
#define F5T_BIVEC4_DOUBLE       F5B_standard_cartesian_chart4D()->DoublePrecision.Vector_hid_t
#define F5T_METRIC44_FLOAT      F5B_standard_cartesian_chart4D()->SinglePrecision.Metric_hid_t
#define F5T_METRIC44_DOUBLE     F5B_standard_cartesian_chart4D()->DoublePrecision.Metric_hid_t
 
#define F5T_COORD4_POLAR_FLOAT  F5B_standard_polar_chart4D()->SinglePrecision.Point_hid_t
#define F5T_COORD4_POLAR_DOUBLE F5B_standard_polar_chart4D()->DoublePrecision.Point_hid_t
 
/* #define      F5T_METRIC33_DOUBLE     F5B_standard_cartesian_chart3D()->DoublePrecision.Metric_hid_t */
 
 
/************* 3D charts ************************/
 
typedef struct  { F5_float_t  x,y,z; } F5_vec3_float_t;
typedef struct  { F5_float_t  x,y,z; } F5_point3_float_t;
 
typedef struct  { F5_double_t x,y,z; } F5_vec3_double_t;
typedef struct  { F5_double_t x,y,z; } F5_point3_double_t;
 
/** Type for vectors in 3D space with single precision  */
typedef F5_vec3_float_t   F5_vec3f_t;
/** Type for points in 3D space with single precision */
typedef F5_point3_float_t F5_point3f_t;
 
/** Type for vectors in 3D space with double precision */
typedef F5_vec3_double_t   F5_vec3d_t;
 
/** Type for points in 3D space with double precision */
typedef F5_point3_double_t F5_point3d_t;
 
 
/* (ancient type, do not use) */
typedef F5_point3f_t F5_vec3_point_t;
 
 
/**
   Symmetric 3x3 tensor in cartesian coordinates.
   \note Corresponding HDF5 type is F5T_METRIC33_FLOAT
  */
typedef struct  { F5_float_t  gxx, gxy, gyy, gxz, gyz, gzz; } F5_metric3_float_t;
typedef F5_metric3_float_t F5_metric3f_t;
 
/**\ingroup coords
   Create a new three-dimensional cartesian coordinate system.
*/
F5_API ChartDomain_IDs*F5B_new_global_cartesian_chart3D();
 
/**\ingroup coords
   Use the predefined three dimensional cartesian standard chart.
   \note This chart is the default chart for all operations which do not
         explicitly specify another chart.
*/
F5_API ChartDomain_IDs*F5B_standard_cartesian_chart3D();
 
#define F5T_COORD3_FLOAT        F5B_standard_cartesian_chart3D()->SinglePrecision.Point_hid_t
#define F5T_VEC3_FLOAT          F5B_standard_cartesian_chart3D()->SinglePrecision.Vector_hid_t
#define F5T_BIVEC3_FLOAT        F5B_standard_cartesian_chart3D()->SinglePrecision.Bivector_hid_t
 
#define F5T_COORD3_DOUBLE       F5B_standard_cartesian_chart3D()->DoublePrecision.Point_hid_t
#define F5T_VEC3_DOUBLE         F5B_standard_cartesian_chart3D()->DoublePrecision.Vector_hid_t
#define F5T_BIVEC3_DOUBLE       F5B_standard_cartesian_chart3D()->DoublePrecision.Bivector_hid_t
 
/**
HDF5 type for symmetric covariant 3x3 tensors
\relates F5_metric3_float_t
*/
#define F5T_METRIC33_FLOAT      F5B_standard_cartesian_chart3D()->SinglePrecision.Metric_hid_t
 
#define F5T_METRIC33_DOUBLE     F5B_standard_cartesian_chart3D()->DoublePrecision.Metric_hid_t
 
 
/**
   A type for storing rational numbers.
 */
typedef  struct
{
        F5_uint32_t  num, denom;
 
}       IntegerFraction32;
 
typedef  struct
{
        F5_uint64_t  num, denom;
 
}       IntegerFraction64;
 
F5_API hid_t    F5T_IntegerFraction32();
#define F5T_INT_FRACTION32      F5T_IntegerFraction32()
 
F5_API hid_t    F5T_IntegerFraction64();
#define F5T_INT_FRACTION64      F5T_IntegerFraction64()
 
typedef struct  { int  ix, iy, iz; } F5_integer_refinement_point_t;
 
/**\ingroup coords
  Create a new domain mapping type where each point is mapped
  to another point, both given by a three-dimensional coordinate
  that is represented by an integer number.
  In this case, each source point maps to exactly one target
  point.
 */
F5_API ChartDomain_IDs*F5B_new_integer_regular_domain3D();
 
typedef struct
{
        IntegerFraction32 x, y, z;
}
   IntegerFraction3D;
 
 
typedef union
{
        IntegerFraction3D  crd;
        IntegerFraction32  d[3];
}
        /** A 32-bit type describing a point in three dimensions using
            rationial integer coordinates. Both (x,y,z)
            and array indexing [0],[1],[2] are supported to
            access the members.
 
            This struct is not very nice. Would be better to
            find a simpler way than n-dimensional integer fractions.
        */
        F5_refinement3D_point_t;
 
/**\ingroup coords
  Create a new domain mapping type where each point is mapped
  to another point, both given by a three-dimensional coordinate
  that is represented by a rational number.
 */
F5_API ChartDomain_IDs*F5B_new_rational_regular_domain3D();
 
/**
   Point given in polar coordinates.
   \todo Add HDF5 type
  */
typedef struct  { F5_float_t  r,theta,phi; } F5_polar_point3_float_t;
 
F5_API ChartDomain_IDs*F5B_new_global_polar_chart3D();
F5_API ChartDomain_IDs*F5B_standard_polar_chart3D();
 
F5_API ChartDomain_IDs*F5B_new_global_cylindrical_chart3D();
 
F5_API ChartDomain_IDs*F5B_new_global_texture_chart3D();
 
/************* mixed time and 2D polar **********/
/* not sure if this is the way how it should be */
F5_API ChartDomain_IDs*F5B_new_global_t_polar2_chart3D();
 
typedef struct  { F5_float_t   t,r,phi; } F5_t_polar2_float_t;
typedef struct  { F5_double_t  t,r,phi; } F5_t_polar2_double_t;
 
#define F5T_T_POLAR2_FLOAT  F5B_new_global_t_polar2_chart3D()->SinglePrecision.Point_hid_t
#define F5T_T_POLAR2_DOUBLE F5B_new_global_t_polar2_chart3D()->DoublePrecision.Point_hid_t
 
 
 
/************* 2D charts ************************/
 
F5_API ChartDomain_IDs*F5B_new_global_cartesian_chart2D();
F5_API ChartDomain_IDs*F5B_new_global_polar_chart2D();
F5_API ChartDomain_IDs*F5B_new_global_spherical_chart2D();
F5_API ChartDomain_IDs*F5B_new_global_axial_chart2D();
 
typedef struct  { F5_float_t  u,v; } F5_texture_point_t;
 
F5_API ChartDomain_IDs*F5B_new_global_texture_chart2D();
 
/** Standard chart for texture coordinates */
F5_API ChartDomain_IDs*F5B_standard_texture_chart2D();
 
/************* 1D charts ************************/
 
F5_API ChartDomain_IDs*F5B_new_global_cartesian_chart1D();
F5_API ChartDomain_IDs*F5B_new_global_spherical_chart1D();
 
F5_API ChartDomain_IDs*F5B_new_global_time_chart1D();
 
 
/**********   CELL TYPES  ******************************/
 
typedef struct { char name[8]; } F5_fragname8_t;
F5_API ChartDomain_IDs*F5B_new_global_fragname();
 
#define F5_FRAGMENT_NEIGHBOUR_CELL_DOMAIN "fragment_neighbor"
#define F5_FRAGMENT_NEIGHBOUR F5B_new_global_fragname()->SinglePrecision.Point_hid_t
 
/**
   Edge pieces.
  */
typedef struct  { F5_uint32_t  i,j; }   F5_edge32_t;
typedef struct  { F5_uint64_t  i,j; }   F5_edge64_t;
 
F5_API ChartDomain_IDs*F5B_new_global_edge_cells();
F5_API ChartDomain_IDs*F5B_standard_edge_cells();
#define F5T_EDGE32              F5B_standard_edge_cells()->SinglePrecision.Point_hid_t
#define F5T_EDGE64              F5B_standard_edge_cells()->DoublePrecision.Point_hid_t
#define F5_EDGE_CELL_DOMAIN "edge"
 
/**
   A triangle.
  */
typedef struct  { F5_uint32_t  i,j,k; }   F5_triangle32_t;
typedef struct  { F5_uint64_t  i,j,k; }   F5_triangle64_t;
 
/**
   Default triangle index precision: 32 bit
 */
typedef F5_triangle32_t F5_triangle_t;
 
F5_API ChartDomain_IDs*F5B_new_global_triangle_cells_ijk();
F5_API ChartDomain_IDs*F5B_standard_triangle_cells_ijk();
 
        
F5_API ChartDomain_IDs*F5B_new_global_triangle_cells();
F5_API ChartDomain_IDs*F5B_standard_triangle_cells();
 
/*
  Triangles using ii,ij,jj as member names.
 */
#define F5T_TRIANGLE32 F5B_standard_triangle_cells()->SinglePrecision.Point_hid_t
#define F5T_TRIANGLE64 F5B_standard_triangle_cells()->DoublePrecision.Point_hid_t
 
/**
   Deprecated: Triangles using i,j,k as member names.
   This naming convention is considered outdated because
   using ii,ij,jj is a more systematic approach.
 */
#define F5T_TRIANGLE32_IJK F5B_standard_triangle_cells_ijk()->SinglePrecision.Point_hid_t
 
#define F5_TRIANGLE_CELL_DOMAIN "triangular"
 
/**
   A cell with four vertices.
  */
typedef struct  { F5_uint32_t  i[2][2]; }   F5_quad_t;
typedef struct  { F5_uint32_t  i[4];    }   F5_quadL_t;
 
F5_API ChartDomain_IDs*F5B_new_global_quad_cells();
F5_API ChartDomain_IDs*F5B_standard_quad_cells();
#define F5T_QUAD32              F5B_standard_quad_cells()->SinglePrecision.Point_hid_t
#define F5_QUAD_CELL_DOMAIN "quad"
 
 
/**
   Tetrahedral cells, four vertices.
  */
typedef struct  { F5_uint32_t  i,j,k,l; }   F5_tetra32_t;
typedef struct  { F5_uint64_t  i,j,k,l; }   F5_tetra64_t;
 
F5_API ChartDomain_IDs*F5B_new_global_tetrahedral_cells();
F5_API ChartDomain_IDs*F5B_standard_tetrahedral_cells();
#define F5T_TETRAHEDRON32       F5B_standard_tetrahedral_cells()->SinglePrecision.Point_hid_t
#define F5T_TETRAHEDRON64       F5B_standard_tetrahedral_cells()->DoublePrecision.Point_hid_t
#define F5_TETRAHEDRON_CELL_DOMAIN "tetrahedral"
 
/**
   A hexahedral cell, preliminiary version.
  */
typedef struct  { F5_uint32_t  i[2][2][2]; }   F5_hexahedron32_t;
typedef struct  { F5_uint32_t  i[8]; }         F5_hexahedronL32_t;
 
F5_API ChartDomain_IDs*F5B_new_global_hexahedral_cells();
F5_API ChartDomain_IDs*F5B_standard_hexahedral_cells();
#define F5T_HEXAHEDRON32        F5B_standard_hexahedral_cells()->SinglePrecision.Point_hid_t
#define F5_HEXAHEDRON_CELL_DOMAIN "hexahedral"
 
 
/****************** color charts *************************/
F5_API ChartDomain_IDs* F5B_new_global_color_chart_rgba_real();
F5_API ChartDomain_IDs* F5B_new_global_color_chart_rgba_int();
 
#define F5T_COLOR_RGBA_32F F5B_new_global_color_chart_rgba_real()->SinglePrecision.Vector_hid_t
#define F5T_COLOR_RGBA_8I  F5B_new_global_color_chart_rgba_int()->OneBytePrecision.Vector_hid_t
 
 
 
/************************************************************/
F5_API void F5Bcoordinate_cleanup();
 
 
 
#ifdef  __cplusplus
}    /* extern "C"  */
#endif
 
#endif  /* __F5B_coordinates_H */