verdict.h

Go to the documentation of this file.

/*=========================================================================

  Module:    verdict.h.in

  Copyright (c) 2006 Sandia Corporation.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/


// .SECTION Thanks
// Prior to its inclusion within VTK, this code was developed by the CUBIT
// project at Sandia National Laboratories. 

#ifndef __verdict_h
#define __verdict_h

#define VERDICT_VERSION 120

#define BUILD_SHARED_LIBS
#ifdef BUILD_SHARED_LIBS
# define VERDICT_SHARED_LIB
#endif

#define VERDICT_MANGLE
#ifdef VERDICT_MANGLE
#  include "verdict_mangle.h"
#endif

#define VERDICT_DBL_MIN 1.0E-30
#define VERDICT_DBL_MAX 1.0E+30
#define VERDICT_PI 3.1415926535897932384626

#if defined(_WIN32) || defined (__CYGWIN__)
# define VERDICT_ABI_IMPORT __declspec(dllimport)
# define VERDICT_ABI_EXPORT __declspec(dllexport)
#elif __GNUC__ >= 4
# define VERDICT_ABI_IMPORT __attribute__ ((visibility("default")))
# define VERDICT_ABI_EXPORT __attribute__ ((visibility("default")))
#else
# define VERDICT_ABI_IMPORT
# define VERDICT_ABI_EXPORT
#endif

#ifdef __cplusplus
# define VERDICT_EXTERN_C extern "C"
#endif

#if defined(VERDICT_SHARED_LIB)
# ifdef verdict_EXPORTS
#  define C_FUNC_DEF VERDICT_EXTERN_C  VERDICT_ABI_EXPORT
# else
#  define C_FUNC_DEF VERDICT_EXTERN_C  VERDICT_ABI_IMPORT
# endif
#else
# define C_FUNC_DEF VERDICT_EXTERN_C
#endif


/* typedef for the user if they want to use
 *    function pointers */
#ifdef __cplusplus
extern "C" {
#endif
  typedef double(*VerdictFunction)(int, double[][3]);
  typedef int(*ComputeNormal)(double point[3], double normal[3]); 
#ifdef __cplusplus
}
#endif


struct HexMetricVals
{
  double edge_ratio ;  
  double max_edge_ratio ;  
  double skew ;
  double taper ;
  double volume ;
  double stretch ;
  double diagonal ;
  double dimension ;
  double oddy ;
  double med_aspect_frobenius ;
  double max_aspect_frobenius ;
  double condition ;
  double jacobian ;
  double scaled_jacobian ;
  double shear ;
  double shape ;
  double relative_size_squared;
  double shape_and_size ; 
  double shear_and_size ; 
  double distortion; 
};

struct EdgeMetricVals
{
  double length ; 
};


struct KnifeMetricVals
{
  double volume ; 
};

struct QuadMetricVals
{
  double edge_ratio ;
  double max_edge_ratio ;
  double aspect_ratio ;
  double radius_ratio ;
  double med_aspect_frobenius ;
  double max_aspect_frobenius ;
  double skew ;
  double taper ;
  double warpage ;
  double area ;
  double stretch ;
  double minimum_angle ;
  double maximum_angle ;
  double oddy ;
  double condition ;
  double jacobian ;
  double scaled_jacobian ;
  double shear ;
  double shape ;
  double relative_size_squared ;
  double shape_and_size ; 
  double shear_and_size ;
  double distortion; 
};

struct PyramidMetricVals
{
  double volume ; 
};
   
struct WedgeMetricVals
{
  double volume ;
  double edge_ratio ;
  double max_aspect_frobenius;
  double mean_aspect_frobenius;
  double jacobian;
  double distortion;
  double max_stretch;
  double scaled_jacobian;
  double shape;
  double condition;
};
     
struct TetMetricVals
{
  double edge_ratio;
  double radius_ratio;
  double aspect_beta;
  double aspect_ratio ;
  double aspect_gamma ;
  double aspect_frobenius ;
  double minimum_angle ;
  double collapse_ratio;
  double volume ;
  double condition ;
  double jacobian ;
  double scaled_jacobian ;
  double shape ;
  double relative_size_squared ;
  double shape_and_size ; 
  double distortion; 
  double equivolume_skew;
  double squish_index;

};

struct TriMetricVals
{
  double edge_ratio ;
  double aspect_ratio ;
  double radius_ratio ;
  double aspect_frobenius ;
  double area ;
  double minimum_angle ;
  double maximum_angle ;
  double condition ;
  double scaled_jacobian ;
  double shape ;
  double relative_size_squared ;
  double shape_and_size ; 
  double distortion; 
};



/* definition of bit fields to determine which metrics to calculate */



#define V_HEX_MAX_EDGE_RATIO         1

#define V_HEX_SKEW                   2

#define V_HEX_TAPER                  4

#define V_HEX_VOLUME                 8

#define V_HEX_STRETCH                16

#define V_HEX_DIAGONAL               32

#define V_HEX_DIMENSION              64

#define V_HEX_ODDY                   128

#define V_HEX_MAX_ASPECT_FROBENIUS   256

#define V_HEX_CONDITION              256

#define V_HEX_JACOBIAN               512

#define V_HEX_SCALED_JACOBIAN        1024

#define V_HEX_SHEAR                  2048

#define V_HEX_SHAPE                  4096

#define V_HEX_RELATIVE_SIZE_SQUARED  8192

#define V_HEX_SHAPE_AND_SIZE         16384

#define V_HEX_SHEAR_AND_SIZE         32768

#define V_HEX_DISTORTION             65536

#define V_HEX_EDGE_RATIO             131072

#define V_HEX_MED_ASPECT_FROBENIUS   262144


#define V_HEX_ALL                    524287

#define V_HEX_TRADITIONAL \
  V_HEX_MAX_EDGE_RATIO + \
  V_HEX_SKEW            + \
  V_HEX_TAPER           + \
  V_HEX_STRETCH         + \
  V_HEX_DIAGONAL        + \
  V_HEX_ODDY            + \
  V_HEX_CONDITION       + \
  V_HEX_JACOBIAN        + \
  V_HEX_SCALED_JACOBIAN + \
  V_HEX_DIMENSION

#define V_HEX_DIAGNOSTIC V_HEX_VOLUME

#define V_HEX_ALGEBRAIC \
  V_HEX_SHAPE                  + \
  V_HEX_SHEAR                  + \
  V_HEX_RELATIVE_SIZE_SQUARED  + \
  V_HEX_SHAPE_AND_SIZE         + \
  V_HEX_SHEAR_AND_SIZE

#define V_HEX_ROBINSON \
  V_HEX_SKEW + \
  V_HEX_TAPER





#define V_TET_RADIUS_RATIO           1

#define V_TET_ASPECT_BETA            2

#define V_TET_ASPECT_GAMMA           4

#define V_TET_VOLUME                 8

#define V_TET_CONDITION              16

#define V_TET_JACOBIAN               32

#define V_TET_SCALED_JACOBIAN        64

#define V_TET_SHAPE                  128

#define V_TET_RELATIVE_SIZE_SQUARED  256

#define V_TET_SHAPE_AND_SIZE         512

#define V_TET_DISTORTION             1024

#define V_TET_EDGE_RATIO             2048

#define V_TET_ASPECT_RATIO           4096

#define V_TET_ASPECT_FROBENIUS       8192

#define V_TET_MINIMUM_ANGLE          16384

#define V_TET_COLLAPSE_RATIO         32768

#define V_TET_EQUIVOLUME_SKEW        65536

#define V_TET_SQUISH_INDEX           131072



#define V_TET_ALL                    262143

#define V_TET_TRADITIONAL            V_TET_ASPECT_BETA + \
                                     V_TET_ASPECT_GAMMA + \
                                     V_TET_CONDITION + \
                                     V_TET_JACOBIAN + \
                                     V_TET_SCALED_JACOBIAN  

#define V_TET_DIAGNOSTIC             V_TET_VOLUME

#define V_TET_ALGEBRAIC              V_TET_SHAPE                  + \
                                     V_TET_RELATIVE_SIZE_SQUARED  + \
                                     V_TET_SHAPE_AND_SIZE



 


#define V_PYRAMID_VOLUME             1

#define V_PYRAMID_ALL \
  V_PYRAMID_VOLUME




#define V_WEDGE_VOLUME                 1
#define V_WEDGE_EDGE_RATIO             2
#define V_WEDGE_MAX_ASPECT_FROBENIUS   4
#define V_WEDGE_MEAN_ASPECT_FROBENIUS  8
#define V_WEDGE_JACOBIAN               16
#define V_WEDGE_SCALED_JACOBIAN        32
#define V_WEDGE_DISTORTION             64
#define V_WEDGE_MAX_STRETCH            128
#define V_WEDGE_SHAPE                  256
#define V_WEDGE_CONDITION              512

#define V_WEDGE_ALL \
  V_WEDGE_VOLUME

 


#define V_KNIFE_VOLUME               1

#define V_KNIFE_ALL \
  V_KNIFE_VOLUME

 


#define V_QUAD_MAX_EDGE_RATIO        1

#define V_QUAD_SKEW                  2

#define V_QUAD_TAPER                 4

#define V_QUAD_WARPAGE               8

#define V_QUAD_AREA                  16

#define V_QUAD_STRETCH               32

#define V_QUAD_MINIMUM_ANGLE         64

#define V_QUAD_MAXIMUM_ANGLE         128

#define V_QUAD_ODDY                  256

#define V_QUAD_CONDITION             512

#define V_QUAD_JACOBIAN              1024

#define V_QUAD_SCALED_JACOBIAN       2048

#define V_QUAD_SHEAR                 4096

#define V_QUAD_SHAPE                 8192

#define V_QUAD_RELATIVE_SIZE_SQUARED 16384

#define V_QUAD_SHAPE_AND_SIZE        32768

#define V_QUAD_SHEAR_AND_SIZE        65536

#define V_QUAD_DISTORTION            131072

#define V_QUAD_EDGE_RATIO            262144

#define V_QUAD_ASPECT_RATIO          524288

#define V_QUAD_RADIUS_RATIO          1048576

#define V_QUAD_MED_ASPECT_FROBENIUS  2097152

#define V_QUAD_MAX_ASPECT_FROBENIUS  4194304

#define V_QUAD_ALL                   8388607

#define V_QUAD_TRADITIONAL \
  V_QUAD_MAX_EDGE_RATIO + \
  V_QUAD_SKEW            + \
  V_QUAD_TAPER           + \
  V_QUAD_WARPAGE         + \
  V_QUAD_STRETCH         + \
  V_QUAD_MINIMUM_ANGLE   + \
  V_QUAD_MAXIMUM_ANGLE   + \
  V_QUAD_ODDY            + \
  V_QUAD_CONDITION       + \
  V_QUAD_JACOBIAN        + \
  V_QUAD_SCALED_JACOBIAN 

#define V_QUAD_DIAGNOSTIC \
  V_QUAD_AREA

#define V_QUAD_ALGEBRAIC \
  V_QUAD_SHEAR                 + \
  V_QUAD_SHAPE                 + \
  V_QUAD_RELATIVE_SIZE_SQUARED + \
  V_QUAD_SHAPE_AND_SIZE     

#define V_QUAD_ROBINSON \
  V_QUAD_MAX_EDGE_RATIO + \
  V_QUAD_SKEW   + \
  V_QUAD_TAPER





#define V_TRI_ASPECT_FROBENIUS       1

#define V_TRI_AREA                   2

#define V_TRI_MINIMUM_ANGLE          4

#define V_TRI_MAXIMUM_ANGLE          8

#define V_TRI_CONDITION              16

#define V_TRI_SCALED_JACOBIAN        32

#define V_TRI_SHAPE                  64

#define V_TRI_RELATIVE_SIZE_SQUARED  128

#define V_TRI_SHAPE_AND_SIZE         256

#define V_TRI_DISTORTION             512

#define V_TRI_RADIUS_RATIO           1024

#define V_TRI_EDGE_RATIO             2048

#define V_TRI_ALL                    4095

#define V_TRI_TRADITIONAL \
  V_TRI_ASPECT_FROBENIUS + \
  V_TRI_MINIMUM_ANGLE + \
  V_TRI_MAXIMUM_ANGLE + \
  V_TRI_CONDITION + \
  V_TRI_SCALED_JACOBIAN 

#define V_TRI_DIAGNOSTIC \
  V_TRI_AREA

#define V_TRI_ALGEBRAIC \
  V_TRI_SHAPE + \
  V_TRI_SHAPE_AND_SIZE + \
  V_TRI_RELATIVE_SIZE_SQUARED

 


#define V_EDGE_LENGTH                1

#define V_EDGE_ALL \
  V_EDGE_LENGTH


                                     
    C_FUNC_DEF void v_hex_quality( int num_nodes, double coordinates[][3], 
        unsigned int metrics_request_flag, struct HexMetricVals *metric_vals ); 
    
    C_FUNC_DEF void v_tet_quality( int num_nodes, double coordinates[][3], 
        unsigned int metrics_request_flag, struct TetMetricVals *metric_vals ); 
    
    C_FUNC_DEF void v_pyramid_quality( int num_nodes, double coordinates[][3], 
        unsigned int metrics_request_flag, struct PyramidMetricVals *metric_vals ); 

    C_FUNC_DEF void v_wedge_quality( int num_nodes, double coordinates[][3], 
        unsigned int metrics_request_flag, struct WedgeMetricVals *metric_vals ); 

    C_FUNC_DEF void v_knife_quality( int num_nodes, double coordinates[][3], 
        unsigned int metrics_request_flag, struct KnifeMetricVals *metric_vals ); 

    C_FUNC_DEF void v_quad_quality( int num_nodes, double coordinates[][3], 
        unsigned int metrics_request_flag, struct QuadMetricVals *metric_vals ); 

    C_FUNC_DEF void v_tri_quality( int num_nodes, double coordinates[][3], 
        unsigned int metrics_request_flag, struct TriMetricVals *metric_vals );

    C_FUNC_DEF void v_edge_quality( int num_nodes, double coordinates[][3], 
        unsigned int metrics_request_flag, struct EdgeMetricVals *metric_vals ); 



/* individual quality functions for hex elements */

    C_FUNC_DEF void v_set_hex_size( double size );


    C_FUNC_DEF double v_hex_edge_ratio( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_hex_max_edge_ratio( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_hex_skew( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_taper( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_volume( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_stretch( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_diagonal( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_dimension( int num_nodes, double coordinates[][3] ); 

    C_FUNC_DEF double v_hex_oddy( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_med_aspect_frobenius( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_max_aspect_frobenius( int num_nodes, double coordinates[][3] ); 
    C_FUNC_DEF double v_hex_condition( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_jacobian( int num_nodes, double coordinates[][3] ); 
    

    C_FUNC_DEF double v_hex_scaled_jacobian( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_shear( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_shape( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_relative_size_squared( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_shape_and_size( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_hex_shear_and_size( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_hex_distortion( int num_nodes, double coordinates[][3] );

/* individual quality functions for tet elements */

    C_FUNC_DEF void v_set_tet_size( double size );


    C_FUNC_DEF double v_tet_edge_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_radius_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_aspect_beta( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_aspect_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_aspect_gamma( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_aspect_frobenius( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_minimum_angle( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_collapse_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_volume( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_condition( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_jacobian( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_scaled_jacobian( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_shape( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_relative_size_squared( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_shape_and_size( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tet_distortion( int num_nodes, double coordinates[][3] ); 
    
/* individual quality functions for pyramid elements */ 

    C_FUNC_DEF double v_pyramid_volume( int num_nodes, double coordinates[][3] ); 


/* individual quality functions for wedge elements */

    C_FUNC_DEF double v_wedge_volume( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_wedge_edge_ratio( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_wedge_max_aspect_frobenius( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_wedge_mean_aspect_frobenius( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_wedge_jacobian( int num_nodes, double coordinates[][3]);


    C_FUNC_DEF double v_wedge_distortion( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_wedge_max_stretch( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_wedge_scaled_jacobian( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_wedge_shape( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_wedge_condition( int num_nodes, double coordinates[][3] );


/* individual quality functions for knife elements */

    C_FUNC_DEF double v_knife_volume( int num_nodes, double coordinates[][3] ); 

    
/* individual quality functions for edge elements */

    C_FUNC_DEF double v_edge_length( int num_nodes, double coordinates[][3] ); 

    
/* individual quality functions for quad elements */
    C_FUNC_DEF void v_set_quad_size( double size );


    C_FUNC_DEF double v_quad_edge_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_max_edge_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_aspect_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_radius_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_med_aspect_frobenius( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_max_aspect_frobenius( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_skew( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_taper( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_warpage( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_area( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_stretch( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_minimum_angle( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_maximum_angle( int num_nodes, double coordinates[][3] ); 

    C_FUNC_DEF double v_quad_oddy( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_condition( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_jacobian( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_scaled_jacobian( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_shear( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_shape( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_relative_size_squared( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_shape_and_size( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_shear_and_size( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_quad_distortion( int num_nodes, double coordinates[][3] ); 


/* individual quality functions for triangle elements */

    C_FUNC_DEF void  v_set_tri_size( double size );

    C_FUNC_DEF void v_set_tri_normal_func( ComputeNormal func );


    C_FUNC_DEF double v_tri_edge_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_aspect_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_radius_ratio( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_aspect_frobenius( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_area( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_minimum_angle( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_maximum_angle( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_condition( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_scaled_jacobian( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_tri_shear( int num_nodes, double coordinates[][3] ); 
    

    C_FUNC_DEF double v_tri_relative_size_squared( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_shape( int num_nodes, double coordinates[][3] ); 


    C_FUNC_DEF double v_tri_shape_and_size( int num_nodes, double coordinates[][3] );


    C_FUNC_DEF double v_tri_distortion( int num_nodes, double coordinates[][3] );



#endif  /* __verdict_h */