Mesquite.hpp

Go to the documentation of this file.

/* *****************************************************************
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2004 Sandia Corporation and Argonne National
    Laboratory.  Under the terms of Contract DE-AC04-94AL85000
    with Sandia Corporation, the U.S. Government retains certain
    rights in this software.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    (lgpl.txt) along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    [email protected], [email protected], [email protected],
    [email protected], [email protected], [email protected]

  ***************************************************************** */
#ifndef MESQUITE_HPP
#define MESQUITE_HPP

#include "moab/MOABConfig.h"

#ifdef _WIN32                // if vc
#ifdef MESQUITE_DLL_EXPORTS  // if we are exporting as dll
#define MESQUITE_EXPORT __declspec( dllexport )
#else                       // else we aren't exporting as dll
#ifdef MESQUITE_STATIC_LIB  // are we compiling a static lib?

#define MESQUITE_EXPORT
#else  // Calling codes need to do nothing if
// they are calling as a dll
#define MESQUITE_EXPORT __declspec( dllimport )
#endif
#endif
#elif defined( __GNUC__ ) && __GNUC__ >= 4
#define MESQUITE_EXPORT __attribute__( ( visibility( "default" ) ) )
#else  // else not vc
#define MESQUITE_EXPORT
#endif

#ifdef WIN32               /* windows */
#define _USE_MATH_DEFINES  // For M_PI
#endif

#include <cmath>
#include <cfloat>
#include <climits>
#include <cstddef>
#ifdef HAVE_CBRT
#include <math.h>
#endif

#include <limits>
#include <vector>
#include <cassert>

/*! \file Mesquite.hpp
 */

/*!
  \namespace Mesquite
  Copyright 2003 Sandia Corporation and the University of Chicago. Under
  the terms of Contract DE-AC04-94AL85000 with Sandia Corporation and
  Contract W-31-109-ENG-38 with the University of Chicago, the U.S.
  Government retains certain rights in this software.

*/
namespace MBMesquite
{

typedef int StatusCode;

typedef double real;

enum StatusCodeValues
{
    MSQ_FAILURE = 0,
    MSQ_SUCCESS
};

enum EntityTopology
{
    POLYGON       = 7,
    TRIANGLE      = 8,
    QUADRILATERAL = 9,
    POLYHEDRON    = 10,
    TETRAHEDRON   = 11,
    HEXAHEDRON    = 12,
    PRISM         = 13,
    PYRAMID       = 14,
    SEPTAHEDRON   = 15,
    MIXED
};

enum AssessSchemes
{
    NO_SCHEME          = 0,
    ELEMENT_AVG_QM     = 1,
    ELEMENT_MAX_QM     = 2,
    TMP_QUALITY_METRIC = 3,
    QUALITY_METRIC     = 4
};

// Version information
MESQUITE_EXPORT const char* version_string( bool );
MESQUITE_EXPORT unsigned int major_version_number();
MESQUITE_EXPORT unsigned int minor_version_number();
MESQUITE_EXPORT unsigned int patch_version_number();
enum ReleaseType
{
    RELEASE,
    BETA,
    ALPHA
};
MESQUITE_EXPORT MBMesquite::ReleaseType release_type();

const bool OF_FREE_EVALS_ONLY = true;

// GLOBAL variables
const int MSQ_MAX_NUM_VERT_PER_ENT              = 8;
const int MSQ_HIST_SIZE                         = 7;  // number of division in histogram
static const double MSQ_SQRT_TWO                = std::sqrt( 2.0 );
static const double MSQ_SQRT_THREE              = std::sqrt( 3.0 );
static const double MSQ_SQRT_THREE_DIV_TWO      = MSQ_SQRT_THREE / 2.0;
static const double MSQ_SQRT_THREE_INV          = 1.0 / MSQ_SQRT_THREE;
static const double MSQ_SQRT_TWO_INV            = 1.0 / MSQ_SQRT_TWO;
static const double MSQ_SQRT_TWO_DIV_SQRT_THREE = MSQ_SQRT_TWO / MSQ_SQRT_THREE;
static const double MSQ_ONE_THIRD               = 1.0 / 3.0;
static const double MSQ_TWO_THIRDS              = 2.0 / 3.0;
static const double MSQ_3RT_2_OVER_6RT_3        = std::pow( 2 / MSQ_SQRT_THREE, MSQ_ONE_THIRD );

#ifdef UINT_MAX
const unsigned MSQ_UINT_MAX = UINT_MAX;
#else
const unsigned MSQ_UINT_MAX = ~(unsigned)0;
#endif

#ifdef INT_MAX
const int MSQ_INT_MAX = INT_MAX;
#else
const int MSQ_INT_MAX       = MSQ_UINT_MAX >> 1;
#endif

#ifdef INT_MIN
const int MSQ_INT_MIN = INT_MIN;
#else
const int MSQ_INT_MIN       = ~MSQ_INT_MAX;
#endif

#ifdef DBL_MIN
const double MSQ_DBL_MIN = DBL_MIN;
#else
/* This value is rather large - DBL_MIN is normally about 2e-308
   Put an error here to see if any platform really doesn't
   have DBL_MIN or DBL_MAX defined, and evaluate what to do then.
*/
#error DBL_MIN not defined
const double MSQ_DBL_MIN = 1.0E-30;
#endif
const double MSQ_MIN = MSQ_DBL_MIN;

#ifdef DBL_MAX
const double MSQ_DBL_MAX = DBL_MAX;
#else
/* This value is rather small - DBL_MAX is normally about 2e308
   Put an error here to see if any platform really doesn't
   have DBL_MIN or DBL_MAX defined, and evaluate what to do then.
*/
#error DBL_MAX not defined
const double MSQ_DBL_MAX = 1.0E30;
#endif
const double MSQ_MAX     = MSQ_DBL_MAX;
const double MSQ_MAX_CAP = 1.e6;

// macro to return the min/max of a set of arguements.  The integer
// (e.g., '2') tells how many arguements should be passed for comparison.
template < class T >
inline T MSQ_MIN_2( T a, T b )
{
    return a < b ? a : b;
}
template < class T >
inline T MSQ_MAX_2( T a, T b )
{
    return a > b ? a : b;
}

// Utility functions
inline double cbrt( double d )
{
#ifdef MOAB_HAVE_CBRT
    return ::cbrt( d );
#else
    return std::pow( d, MSQ_ONE_THIRD );
#endif
}

inline double cbrt_sqr( double d )
{
#ifdef MOAB_HAVE_CBRT
    return ::cbrt( d * d );
#else
    return std::pow( d, MSQ_TWO_THIRDS );
#endif
}

/**\brief Perform safe division (no overflow or div by zero).
 *
 * Do result = num/den iff it would not result in an overflow or div by zero
 *\param num  Numerator of division.
 *\param den  Denominator of division
 *\param result The result of the division if valid, zero otherwise.
 *\return false if the result of the division would be invalid (inf or nan),
 *        true otherwise.
 */
inline bool divide( double num, double den, double& result )
{
    const double fden = fabs( den );
    // NOTE: First comparison is necessary to avoid overflow in second.
    // NOTE: Comparison in second half of condition must be '<'
    //       rather than '<=' to correctly handle 0/0.
    if( fden >= 1 || fabs( num ) < fden * std::numeric_limits< double >::max() )
    {
        result = num / den;
        return true;
    }
    else
    {
        result = 0.0;
        return false;
    }
}

/**\brief get array pointer from std::vector */
template < typename T >
inline T* arrptr( std::vector< T >& v, bool check_zero_size = false )
{
    if( check_zero_size && !v.size() ) return 0;
    assert( !v.empty() );
    return &v[0];
}
template < typename T >
inline const T* arrptr( const std::vector< T >& v, bool check_zero_size = false )
{
    if( check_zero_size && !v.size() ) return 0;
    assert( !v.empty() );
    return &v[0];
}

}  // namespace MBMesquite

#endif