base_uses.f90

Go to the documentation of this file.

! Basic use statements and preprocessor macros
! should be included in the use statements
 
  USE base_hooks,                      ONLY: cp__a,&
                                             cp__b,&
                                             cp__w,&
                                             cp__h,&
                                             cp__l,&
                                             cp_abort,&
                                             cp_warn,&
                                             cp_hint,&
                                             timeset,&
                                             timestop
 
#if defined(__OFFLOAD_CUDA) || defined(__OFFLOAD_HIP)
#define __OFFLOAD
#endif
 
! Check for OpenMP early on - ideally before the compiler fails with a cryptic message.
#if !defined(_OPENMP)
   "OpenMP is required. Please add the corresponding flag (eg. -fopenmp for GFortran) to your Fortran compiler flags."
#endif
 
#if !defined(__SHORT_FILE__)
   "The preprocessor macro __SHORT_FILE__ is required but has not been defined."
#endif
 
#define __LOCATION__ cp__l(__SHORT_FILE__,__LINE__)
#define CPABORT(MSG) CALL cp__b(__SHORT_FILE__,__LINE__,MSG)
 
! Issue a warning; warnings are summarized globally.
! For conditional warnings see CPWARN_IF.
#define CPWARN(MSG) CALL cp__w(__SHORT_FILE__,__LINE__,MSG)
 
! Like CPWARN but only if CONDition is true.
#define CPWARN_IF(COND, MSG) IF(COND)CPWARN(MSG)
 
! In contrast to CPWARN, the warning counter is not increased
#define CPHINT(MSG) CALL cp__h(__SHORT_FILE__,__LINE__,MSG)
 
# define CPASSERT(COND) IF(.NOT.(COND))CALL cp__a(__SHORT_FILE__,__LINE__)
 
! The MARK_USED macro can be used to mark an argument/variable as used. It is intended to make
! it possible to switch on -Werror=unused-dummy-argument, but deal elegantly with, e.g.,
! library wrapper routines that take arguments only used if the library is linked in.
! This code should be valid for any Fortran variable, is always standard conforming,
! and will be optimized away completely by the compiler
#define MARK_USED(FOO) IF(.FALSE.)THEN;DO;IF(SIZE(SHAPE(FOO))==-1) EXIT;ENDDO;ENDIF
 
! Calculate version number from 2 or 3 components. Can be used for comparison, e.g.,
! CPVERSION3(4, 9, 0) <= CPVERSION3(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__)
! CPVERSION(8, 0) <= CPVERSION(__GNUC__, __GNUC_MINOR__)
#define CPVERSION2(MAJOR, MINOR) ((MAJOR) * 10000 + (MINOR) * 100)
#define CPVERSION3(MAJOR, MINOR, UPDATE) (CPVERSION2(MAJOR, MINOR) + (UPDATE))
#define CPVERSION CPVERSION2
 
! On top of CPVERSION macro, test if MAJOR_TEST and MINOR_TEST are defined.
! Usage:  #if CPVERSION_CHECK(9, 5, >, __GNUC__, __GNUC_MINOR__)
! Perform actual comparison according to COMP argument.
! Note: defined(MAJOR_TEST) and defined(MINOR_TEST) is avoided in macro
!       definition due to issues handling it in certain compilers.
#define CPVERSION_CHECK(MAJOR_BASE, MINOR_BASE, COMP, MAJOR_TEST, MINOR_TEST) ((MAJOR_TEST) && \
  (cpversion2(major_base, minor_base) comp cpversion2(major_test, minor_test)))
 
! Avoid to default initialize type-components (default c'tor)
#if CPVERSION_CHECK(9, 5, >, __GNUC__, __GNUC_MINOR__) || defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER)
#define FTN_NO_DEFAULT_INIT
#endif
 
! gfortran before 8.3 complains about internal symbols not being specified in
! any data clause when using DEFAULT(NONE) and OOP procedures are called from
! within the parallel region.
#if CPVERSION_CHECK(8, 3, >, __GNUC__, __GNUC_MINOR__)
#define OMP_DEFAULT_NONE_WITH_OOP SHARED
#else
#define OMP_DEFAULT_NONE_WITH_OOP NONE
#endif
 
#if defined (__MKL)
! Preprocessing is enabled by default, and below header is not language specific
! Defines __INTEL_MKL__ (2025), __INTEL_MKL_MINOR__ (0), __INTEL_MKL_UPDATE__ (2),
! and __INTEL_MKL_PATCH__ (0) as well INTEL_MKL_VERSION, e.g., 20250200.
#include <mkl_version.h>
#endif