GeosxMacros.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#include "common/GeosxConfig.hpp"
#include "LvArray/src/Macros.hpp"
 
#ifndef GEOS_COMMON_GEOSXMACROS_HPP_
#define GEOS_COMMON_GEOSXMACROS_HPP_
 
 
#if defined(GEOS_USE_DEVICE)
#define GEOS_HOST __host__
#define GEOS_DEVICE __device__
#define GEOS_HOST_DEVICE __host__ __device__
#define GEOS_FORCE_INLINE __forceinline__
#define PRAGMA_UNROLL _Pragma("unroll")
#else
#define GEOS_HOST
#define GEOS_DEVICE
#define GEOS_HOST_DEVICE
#define GEOS_FORCE_INLINE inline
#define PRAGMA_UNROLL
#endif
 
#if defined(__CUDA_ARCH__) || defined(__HIP_DEVICE_COMPILE__)
#define GEOS_DEVICE_COMPILE
#endif
 
 
 
#define GEOS_UNUSED_PARAM( X )
 
template< typename ... ARGS >
GEOS_HOST_DEVICE inline constexpr
void i_g_n_o_r_e( ARGS const & ... ) {}
 
#define GEOS_UNUSED_VAR( ... ) i_g_n_o_r_e( __VA_ARGS__ )
 
#define GEOS_DEBUG_VAR( ... ) GEOS_UNUSED_VAR( __VA_ARGS__ )
 
 
#if defined(GEOS_USE_OPENMP)
#define PRAGMA_OMP( clause ) _Pragma( clause )
//  #define PRAGMA_OMP( clause ) _Pragma( STRINGIZE( omp clause ) )
#else
#define PRAGMA_OMP( clause )
#endif
 
#define GEOS_RESTRICT LVARRAY_RESTRICT
 
#define GEOS_RESTRICT_THIS LVARRAY_RESTRICT_THIS
 
#define GEOS_DECLTYPE_AUTO_RETURN decltype( auto )
 
#define GEOS_CONCAT_IMPL( A, B ) A ## B
 
#define GEOS_CONCAT( A, B ) GEOS_CONCAT_IMPL( A, B )
 
#if __cplusplus >= 201703L
#define GEOS_MAYBE_UNUSED [[maybe_unused]]
#else
// If not C++17 or later, check the compiler.
    #ifdef _MSC_VER
// Microsoft Visual Studio
#define GEOS_MAYBE_UNUSED __pragma(warning(suppress: 4100))
    #elif defined(__GNUC__) || defined(__clang__)
// GCC or Clang
#define GEOS_MAYBE_UNUSED __attribute__((unused))
    #else
// If the compiler is unknown, we can't suppress the warning,
// so we define GEOS_MAYBE_UNUSED as an empty macro.
#define GEOS_MAYBE_UNUSED
    #endif
#endif
 
 
#define GEOS_DETAIL_MORE_THAN_ONE_ARG_VALUE( _00, _01, _02, _03, _04, _05, _06, _07, \
                                             _08, _09, _10, _11, _12, _13, _14, _15, \
                                             _INDEX, ... ) _INDEX
 
#define GEOS_DETAIL_MORE_THAN_ONE_ARG( ... ) \
  GEOS_DETAIL_MORE_THAN_ONE_ARG_VALUE( __VA_ARGS__, \
                                       true, true, true, true, true, true, true, true, \
                                       true, true, true, true, true, true, true, false, false )
 
 
#define GEOS_DETAIL_FIRST_ARG_false( FIRST ) FIRST
#define GEOS_DETAIL_FIRST_ARG_true( FIRST, ... ) FIRST
#define GEOS_DETAIL_FIRST_ARG_FUNC( COND ) GEOS_DETAIL_FIRST_ARG_ ## COND
#define GEOS_DETAIL_FIRST_ARG_DISPATCH( COND, ... ) GEOS_DETAIL_FIRST_ARG_FUNC( COND )(__VA_ARGS__)
 
#define GEOS_DETAIL_REST_ARGS_false( FIRST )
#define GEOS_DETAIL_REST_ARGS_true( FIRST, ... ) __VA_ARGS__
#define GEOS_DETAIL_REST_ARGS_FUNC( COND ) GEOS_DETAIL_REST_ARGS_ ## COND
#define GEOS_DETAIL_REST_ARGS_DISPATCH( COND, ... ) GEOS_DETAIL_REST_ARGS_FUNC( COND )(__VA_ARGS__)
 
#define GEOS_DETAIL_REST_PREP_ARGS_false( FIRST )
#define GEOS_DETAIL_REST_PREP_ARGS_true( FIRST, ... ) , __VA_ARGS__
#define GEOS_DETAIL_REST_PREP_ARGS_FUNC( COND ) GEOS_DETAIL_REST_PREP_ARGS_ ## COND
#define GEOS_DETAIL_REST_PREP_ARGS_DISPATCH( COND, ... ) GEOS_DETAIL_REST_PREP_ARGS_FUNC( COND )(__VA_ARGS__)
 
 
#define GEOS_DETAIL_FIRST_ARG( ... ) GEOS_DETAIL_FIRST_ARG_DISPATCH( GEOS_DETAIL_MORE_THAN_ONE_ARG( __VA_ARGS__ ), \
                                                                     __VA_ARGS__ )
 
#define GEOS_DETAIL_REST_ARGS( ... ) GEOS_DETAIL_REST_ARGS_DISPATCH( GEOS_DETAIL_MORE_THAN_ONE_ARG( __VA_ARGS__ ), \
                                                                     __VA_ARGS__ )
 
#define GEOS_DETAIL_REST_PREP_ARGS( ... ) GEOS_DETAIL_REST_PREP_ARGS_DISPATCH( GEOS_DETAIL_MORE_THAN_ONE_ARG( __VA_ARGS__ ), \
                                                                               __VA_ARGS__ )
 
 
#endif // GEOS_COMMON_GEOSXMACROS_HPP_