1e489efc1SBarry Smith /* 2314da920SBarry Smith 3314da920SBarry Smith PETSc mathematics include file. Defines certain basic mathematical 4a5057860SBarry Smith constants and functions for working with single, double, and quad precision 5a5057860SBarry Smith floating point numbers as well as complex single and double. 6314da920SBarry Smith 7d382aafbSBarry Smith This file is included by petscsys.h and should not be used directly. 8e7029fe1SSatish Balay 9e489efc1SBarry Smith */ 10e489efc1SBarry Smith 11488ecbafSBarry Smith #if !defined(__PETSCMATH_H) 12488ecbafSBarry Smith #define __PETSCMATH_H 130a5f7794SBarry Smith #include <math.h> 140a5f7794SBarry Smith 15314da920SBarry Smith /* 16f4ccad53SBarry Smith 17f4ccad53SBarry Smith Defines operations that are different for complex and real numbers; 18a5057860SBarry Smith note that one cannot mix the use of complex and real in the same 19f4ccad53SBarry Smith PETSc program. All PETSc objects in one program are built around the object 2098725619SBarry Smith PetscScalar which is either always a real or a complex. 21f4ccad53SBarry Smith 22e489efc1SBarry Smith */ 23b36a9721SBarry Smith 24c1d390e3SJed Brown #if defined(PETSC_USE_REAL_SINGLE) 25c1d390e3SJed Brown #define MPIU_REAL MPI_FLOAT 26c1d390e3SJed Brown typedef float PetscReal; 279cf33046SSatish Balay #define PetscSqrtReal(a) sqrt(a) 289a07f4dfSJed Brown #define PetscExpReal(a) exp(a) 299a07f4dfSJed Brown #define PetscLogReal(a) log(a) 3077b4d14cSPeter Brune #define PetscLog10Real(a) log10(a) 3178a59e97SMatthew G. Knepley #ifdef PETSC_HAVE_LOG2 3278a59e97SMatthew G. Knepley #define PetscLog2Real(a) log2(a) 3378a59e97SMatthew G. Knepley #endif 349a07f4dfSJed Brown #define PetscSinReal(a) sin(a) 359a07f4dfSJed Brown #define PetscCosReal(a) cos(a) 36a4bea5a6SPeter Brune #define PetscTanReal(a) tan(a) 37255453a1SBarry Smith #define PetscAsinReal(a) asin(a) 38255453a1SBarry Smith #define PetscAcosReal(a) acos(a) 39a4bea5a6SPeter Brune #define PetscAtanReal(a) atan(a) 401d5abddaSDmitry Karpeev #define PetscAtan2Real(a,b) atan2(a,b) 41a4bea5a6SPeter Brune #define PetscSinhReal(a) sinh(a) 42a4bea5a6SPeter Brune #define PetscCoshReal(a) cosh(a) 43a4bea5a6SPeter Brune #define PetscTanhReal(a) tanh(a) 44369cc0aeSBarry Smith #define PetscPowReal(a,b) pow(a,b) 4577b4d14cSPeter Brune #define PetscCeilReal(a) ceil(a) 4677b4d14cSPeter Brune #define PetscFloorReal(a) floor(a) 47a4bea5a6SPeter Brune #define PetscFmodReal(a,b) fmod(a,b) 4843f0d3baSJed Brown #define PetscTGamma(a) tgammaf(a) 49c1d390e3SJed Brown #elif defined(PETSC_USE_REAL_DOUBLE) 50c1d390e3SJed Brown #define MPIU_REAL MPI_DOUBLE 51c1d390e3SJed Brown typedef double PetscReal; 528f1a2a5eSBarry Smith #define PetscSqrtReal(a) sqrt(a) 539a07f4dfSJed Brown #define PetscExpReal(a) exp(a) 549a07f4dfSJed Brown #define PetscLogReal(a) log(a) 5577b4d14cSPeter Brune #define PetscLog10Real(a) log10(a) 5678a59e97SMatthew G. Knepley #ifdef PETSC_HAVE_LOG2 5778a59e97SMatthew G. Knepley #define PetscLog2Real(a) log2(a) 5878a59e97SMatthew G. Knepley #endif 599a07f4dfSJed Brown #define PetscSinReal(a) sin(a) 609a07f4dfSJed Brown #define PetscCosReal(a) cos(a) 61a4bea5a6SPeter Brune #define PetscTanReal(a) tan(a) 62255453a1SBarry Smith #define PetscAsinReal(a) asin(a) 63255453a1SBarry Smith #define PetscAcosReal(a) acos(a) 64a4bea5a6SPeter Brune #define PetscAtanReal(a) atan(a) 651d5abddaSDmitry Karpeev #define PetscAtan2Real(a,b) atan2(a,b) 668d1b9be0SJed Brown #define PetscSinhReal(a) sinh(a) 678d1b9be0SJed Brown #define PetscCoshReal(a) cosh(a) 688d1b9be0SJed Brown #define PetscTanhReal(a) tanh(a) 69369cc0aeSBarry Smith #define PetscPowReal(a,b) pow(a,b) 7077b4d14cSPeter Brune #define PetscCeilReal(a) ceil(a) 7177b4d14cSPeter Brune #define PetscFloorReal(a) floor(a) 72a4bea5a6SPeter Brune #define PetscFmodReal(a,b) fmod(a,b) 730646a658SBarry Smith #define PetscTGamma(a) tgamma(a) 74c1d390e3SJed Brown #elif defined(PETSC_USE_REAL___FLOAT128) 75574fde7bSSatish Balay #if defined(__cplusplus) 76574fde7bSSatish Balay extern "C" { 77574fde7bSSatish Balay #endif 78574fde7bSSatish Balay #include <quadmath.h> 79574fde7bSSatish Balay #if defined(__cplusplus) 80574fde7bSSatish Balay } 81574fde7bSSatish Balay #endif 828ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU___FLOAT128 PetscAttrMPITypeTag(__float128); 83c1d390e3SJed Brown #define MPIU_REAL MPIU___FLOAT128 84c1d390e3SJed Brown typedef __float128 PetscReal; 858f1a2a5eSBarry Smith #define PetscSqrtReal(a) sqrtq(a) 869a07f4dfSJed Brown #define PetscExpReal(a) expq(a) 879a07f4dfSJed Brown #define PetscLogReal(a) logq(a) 8877b4d14cSPeter Brune #define PetscLog10Real(a) log10q(a) 8978a59e97SMatthew G. Knepley #ifdef PETSC_HAVE_LOG2 9078a59e97SMatthew G. Knepley #define PetscLog2Real(a) log2q(a) 9178a59e97SMatthew G. Knepley #endif 929a07f4dfSJed Brown #define PetscSinReal(a) sinq(a) 939a07f4dfSJed Brown #define PetscCosReal(a) cosq(a) 94a4bea5a6SPeter Brune #define PetscTanReal(a) tanq(a) 95255453a1SBarry Smith #define PetscAsinReal(a) asinq(a) 96255453a1SBarry Smith #define PetscAcosReal(a) acosq(a) 97a4bea5a6SPeter Brune #define PetscAtanReal(a) atanq(a) 981d5abddaSDmitry Karpeev #define PetscAtan2Real(a,b) atan2q(a,b) 998d1b9be0SJed Brown #define PetscSinhReal(a) sinhq(a) 1008d1b9be0SJed Brown #define PetscCoshReal(a) coshq(a) 1018d1b9be0SJed Brown #define PetscTanhReal(a) tanhq(a) 102369cc0aeSBarry Smith #define PetscPowReal(a,b) powq(a,b) 10377b4d14cSPeter Brune #define PetscCeilReal(a) ceilq(a) 10477b4d14cSPeter Brune #define PetscFloorReal(a) floorq(a) 105a4bea5a6SPeter Brune #define PetscFmodReal(a,b) fmodq(a,b) 1060646a658SBarry Smith #define PetscTGamma(a) tgammaq(a) 107c1d390e3SJed Brown #endif /* PETSC_USE_REAL_* */ 10859cb5930SBarry Smith 1091093a601SBarry Smith /* 1101093a601SBarry Smith Complex number definitions 1111093a601SBarry Smith */ 1122f217381SBarry Smith #if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX) && !defined(PETSC_USE_REAL___FLOAT128) 1138cd53115SBarry Smith #if !defined(PETSC_SKIP_COMPLEX) 11450f81f78SJed Brown #define PETSC_HAVE_COMPLEX 1 1151093a601SBarry Smith /* C++ support of complex number */ 116debe9ee2SPaul Mullowney #if defined(PETSC_HAVE_CUSP) 117debe9ee2SPaul Mullowney #define complexlib cusp 1189ae82921SPaul Mullowney #include <cusp/complex.h> 119debe9ee2SPaul Mullowney #else 120debe9ee2SPaul Mullowney #define complexlib std 121debe9ee2SPaul Mullowney #include <complex> 1229ae82921SPaul Mullowney #endif 123b7940d39SSatish Balay 12450f81f78SJed Brown #define PetscRealPartComplex(a) (a).real() 12550f81f78SJed Brown #define PetscImaginaryPartComplex(a) (a).imag() 12650f81f78SJed Brown #define PetscAbsComplex(a) complexlib::abs(a) 12750f81f78SJed Brown #define PetscConjComplex(a) complexlib::conj(a) 12850f81f78SJed Brown #define PetscSqrtComplex(a) complexlib::sqrt(a) 12950f81f78SJed Brown #define PetscPowComplex(a,b) complexlib::pow(a,b) 13050f81f78SJed Brown #define PetscExpComplex(a) complexlib::exp(a) 13150f81f78SJed Brown #define PetscLogComplex(a) complexlib::log(a) 13250f81f78SJed Brown #define PetscSinComplex(a) complexlib::sin(a) 13350f81f78SJed Brown #define PetscCosComplex(a) complexlib::cos(a) 134255453a1SBarry Smith #define PetscAsinComplex(a) complexlib::asin(a) 135255453a1SBarry Smith #define PetscAcosComplex(a) complexlib::acos(a) 136027d9794SBarry Smith #if defined(PETSC_HAVE_TANCOMPLEX) 137a4bea5a6SPeter Brune #define PetscTanComplex(a) complexlib::tan(a) 138027d9794SBarry Smith #else 139027d9794SBarry Smith #define PetscTanComplex(a) PetscSinComplex(a)/PetscCosComplex(a) 140027d9794SBarry Smith #endif 141a4bea5a6SPeter Brune #define PetscSinhComplex(a) complexlib::sinh(a) 142a4bea5a6SPeter Brune #define PetscCoshComplex(a) complexlib::cosh(a) 143027d9794SBarry Smith #if defined(PETSC_HAVE_TANHCOMPLEX) 144a4bea5a6SPeter Brune #define PetscTanhComplex(a) complexlib::tanh(a) 145027d9794SBarry Smith #else 146027d9794SBarry Smith #define PetscTanhComplex(a) PetscSinhComplex(a)/PetscCoshComplex(a) 147027d9794SBarry Smith #endif 148debe9ee2SPaul Mullowney 149debe9ee2SPaul Mullowney #if defined(PETSC_USE_REAL_SINGLE) 15050f81f78SJed Brown typedef complexlib::complex<float> PetscComplex; 151*3be776deSLisandro Dalcin #if defined(PETSC_USE_CXX_COMPLEX_FLOAT_WORKAROUND) 152*3be776deSLisandro Dalcin static inline PetscComplex operator+(const PetscComplex& lhs, const double& rhs) { return lhs + float(rhs); } 153*3be776deSLisandro Dalcin static inline PetscComplex operator+(const double& lhs, const PetscComplex& rhs) { return float(lhs) + rhs; } 154*3be776deSLisandro Dalcin static inline PetscComplex operator-(const PetscComplex& lhs, const double& rhs) { return lhs - float(rhs); } 155*3be776deSLisandro Dalcin static inline PetscComplex operator-(const double& lhs, const PetscComplex& rhs) { return float(lhs) - rhs; } 156*3be776deSLisandro Dalcin static inline PetscComplex operator*(const PetscComplex& lhs, const double& rhs) { return lhs * float(rhs); } 157*3be776deSLisandro Dalcin static inline PetscComplex operator*(const double& lhs, const PetscComplex& rhs) { return float(lhs) * rhs; } 158*3be776deSLisandro Dalcin static inline PetscComplex operator/(const PetscComplex& lhs, const double& rhs) { return lhs / float(rhs); } 159*3be776deSLisandro Dalcin static inline PetscComplex operator/(const double& lhs, const PetscComplex& rhs) { return float(lhs) / rhs; } 160*3be776deSLisandro Dalcin static inline bool operator==(const PetscComplex& lhs, const double& rhs) { return lhs.imag() == float(0) && lhs.real() == float(rhs); } 161*3be776deSLisandro Dalcin static inline bool operator==(const double& lhs, const PetscComplex& rhs) { return rhs.imag() == float(0) && rhs.real() == float(lhs); } 162*3be776deSLisandro Dalcin static inline bool operator!=(const PetscComplex& lhs, const double& rhs) { return lhs.imag() != float(0) || lhs.real() != float(rhs); } 163*3be776deSLisandro Dalcin static inline bool operator!=(const double& lhs, const PetscComplex& rhs) { return rhs.imag() != float(0) || rhs.real() != float(lhs); } 164*3be776deSLisandro Dalcin #endif /* PETSC_USE_CXX_COMPLEX_FLOAT_WORKAROUND */ 165debe9ee2SPaul Mullowney #elif defined(PETSC_USE_REAL_DOUBLE) 16650f81f78SJed Brown typedef complexlib::complex<double> PetscComplex; 1678c764dc5SJose Roman #elif defined(PETSC_USE_REAL___FLOAT128) 16850f81f78SJed Brown typedef complexlib::complex<__float128> PetscComplex; /* Notstandard and not expected to work, use __complex128 */ 16922b3908eSBarry Smith PETSC_EXTERN MPI_Datatype MPIU___COMPLEX128; 170debe9ee2SPaul Mullowney #endif /* PETSC_USE_REAL_ */ 1718cd53115SBarry Smith #endif /* ! PETSC_SKIP_COMPLEX */ 172debe9ee2SPaul Mullowney 1732f217381SBarry Smith #elif !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX) 1748cd53115SBarry Smith #if !defined(PETSC_SKIP_COMPLEX) 1759f20b660SSatish Balay #define PETSC_HAVE_COMPLEX 1 176519e2a1fSPaul Mullowney #include <complex.h> 177519e2a1fSPaul Mullowney 178ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 17950f81f78SJed Brown typedef float _Complex PetscComplex; 18085b47369SMatthew Knepley 18150f81f78SJed Brown #define PetscRealPartComplex(a) crealf(a) 18250f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimagf(a) 18350f81f78SJed Brown #define PetscAbsComplex(a) cabsf(a) 18450f81f78SJed Brown #define PetscConjComplex(a) conjf(a) 18550f81f78SJed Brown #define PetscSqrtComplex(a) csqrtf(a) 18650f81f78SJed Brown #define PetscPowComplex(a,b) cpowf(a,b) 18750f81f78SJed Brown #define PetscExpComplex(a) cexpf(a) 18850f81f78SJed Brown #define PetscLogComplex(a) clogf(a) 18950f81f78SJed Brown #define PetscSinComplex(a) csinf(a) 19050f81f78SJed Brown #define PetscCosComplex(a) ccosf(a) 191255453a1SBarry Smith #define PetscAsinComplex(a) casinf(a) 192255453a1SBarry Smith #define PetscAcosComplex(a) cacosf(a) 193a4bea5a6SPeter Brune #define PetscTanComplex(a) ctanf(a) 194a4bea5a6SPeter Brune #define PetscSinhComplex(a) csinhf(a) 195a4bea5a6SPeter Brune #define PetscCoshComplex(a) ccoshf(a) 196a4bea5a6SPeter Brune #define PetscTanhComplex(a) ctanhf(a) 1971093a601SBarry Smith 198ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_DOUBLE) 19950f81f78SJed Brown typedef double _Complex PetscComplex; 2001093a601SBarry Smith 20150f81f78SJed Brown #define PetscRealPartComplex(a) creal(a) 20250f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimag(a) 20350f81f78SJed Brown #define PetscAbsComplex(a) cabs(a) 20450f81f78SJed Brown #define PetscConjComplex(a) conj(a) 20550f81f78SJed Brown #define PetscSqrtComplex(a) csqrt(a) 20650f81f78SJed Brown #define PetscPowComplex(a,b) cpow(a,b) 20750f81f78SJed Brown #define PetscExpComplex(a) cexp(a) 20850f81f78SJed Brown #define PetscLogComplex(a) clog(a) 20950f81f78SJed Brown #define PetscSinComplex(a) csin(a) 21050f81f78SJed Brown #define PetscCosComplex(a) ccos(a) 211255453a1SBarry Smith #define PetscAsinComplex(a) casin(a) 212255453a1SBarry Smith #define PetscAcosComplex(a) cacos(a) 213a4bea5a6SPeter Brune #define PetscTanComplex(a) ctan(a) 214a4bea5a6SPeter Brune #define PetscSinhComplex(a) csinh(a) 215a4bea5a6SPeter Brune #define PetscCoshComplex(a) ccosh(a) 216a4bea5a6SPeter Brune #define PetscTanhComplex(a) ctanh(a) 2171093a601SBarry Smith 2188c764dc5SJose Roman #elif defined(PETSC_USE_REAL___FLOAT128) 21950f81f78SJed Brown typedef __complex128 PetscComplex; 2208ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU___COMPLEX128 PetscAttrMPITypeTag(__complex128); 2218c764dc5SJose Roman 22250f81f78SJed Brown #define PetscRealPartComplex(a) crealq(a) 22350f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimagq(a) 22450f81f78SJed Brown #define PetscAbsComplex(a) cabsq(a) 22550f81f78SJed Brown #define PetscConjComplex(a) conjq(a) 22650f81f78SJed Brown #define PetscSqrtComplex(a) csqrtq(a) 22750f81f78SJed Brown #define PetscPowComplex(a,b) cpowq(a,b) 22850f81f78SJed Brown #define PetscExpComplex(a) cexpq(a) 22950f81f78SJed Brown #define PetscLogComplex(a) clogq(a) 23050f81f78SJed Brown #define PetscSinComplex(a) csinq(a) 23150f81f78SJed Brown #define PetscCosComplex(a) ccosq(a) 232255453a1SBarry Smith #define PetscAsinComplex(a) casinq(a) 233255453a1SBarry Smith #define PetscAcosComplex(a) cacosq(a) 234a4bea5a6SPeter Brune #define PetscTanComplex(a) ctanq(a) 235a4bea5a6SPeter Brune #define PetscSinhComplex(a) csinhq(a) 236a4bea5a6SPeter Brune #define PetscCoshComplex(a) ccoshq(a) 237a4bea5a6SPeter Brune #define PetscTanhComplex(a) ctanhq(a) 238a4bea5a6SPeter Brune 239ce63c4c1SBarry Smith #endif /* PETSC_USE_REAL_* */ 240d4161b4aSBarry Smith #elif (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX)) 24150f81f78SJed Brown #error "PETSc was configured --with-scalar-type=complex, but a language-appropriate complex library is not available" 2428cd53115SBarry Smith #endif /* !PETSC_SKIP_COMPLEX */ 2432f217381SBarry Smith #endif /* (__cplusplus && PETSC_HAVE_CXX_COMPLEX) else-if (!__cplusplus && PETSC_HAVE_C99_COMPLEX) */ 244e489efc1SBarry Smith 2458dc6f2c2SJed Brown #if defined(PETSC_HAVE_COMPLEX) 24670da9c3bSJed Brown #if defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 247500d8756SSatish Balay #define MPIU_C_DOUBLE_COMPLEX MPI_C_DOUBLE_COMPLEX 248500d8756SSatish Balay #define MPIU_C_COMPLEX MPI_C_COMPLEX 24970da9c3bSJed Brown #else 2502f217381SBarry Smith # if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX) 2518ad47952SJed Brown typedef complexlib::complex<double> petsc_mpiu_c_double_complex; 2528ad47952SJed Brown typedef complexlib::complex<float> petsc_mpiu_c_complex; 2532f217381SBarry Smith # elif !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX) 2548ad47952SJed Brown typedef double _Complex petsc_mpiu_c_double_complex; 2558ad47952SJed Brown typedef float _Complex petsc_mpiu_c_complex; 2568ad47952SJed Brown # else 2578ad47952SJed Brown typedef struct {double real,imag;} petsc_mpiu_c_double_complex; 2588ad47952SJed Brown typedef struct {float real,imag;} petsc_mpiu_c_complex; 2598ad47952SJed Brown # endif 2608ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_C_DOUBLE_COMPLEX PetscAttrMPITypeTagLayoutCompatible(petsc_mpiu_c_double_complex); 2618ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_C_COMPLEX PetscAttrMPITypeTagLayoutCompatible(petsc_mpiu_c_complex); 2621b65fc54SMatthew G Knepley #endif /* PETSC_HAVE_MPI_C_DOUBLE_COMPLEX */ 2638dc6f2c2SJed Brown #endif /* PETSC_HAVE_COMPLEX */ 2642c876bd9SBarry Smith 2657c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 2667c2de775SJed Brown # if defined(PETSC_USE_REAL_SINGLE) 2677c2de775SJed Brown # define MPIU_COMPLEX MPIU_C_COMPLEX 2687c2de775SJed Brown # elif defined(PETSC_USE_REAL_DOUBLE) 2697c2de775SJed Brown # define MPIU_COMPLEX MPIU_C_DOUBLE_COMPLEX 2707c2de775SJed Brown # elif defined(PETSC_USE_REAL___FLOAT128) 2717c2de775SJed Brown # define MPIU_COMPLEX MPIU___COMPLEX128 2727c2de775SJed Brown # endif /* PETSC_USE_REAL_* */ 2737c2de775SJed Brown #endif 2747c2de775SJed Brown 275d4161b4aSBarry Smith #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX)) 27650f81f78SJed Brown typedef PetscComplex PetscScalar; 27750f81f78SJed Brown #define PetscRealPart(a) PetscRealPartComplex(a) 27850f81f78SJed Brown #define PetscImaginaryPart(a) PetscImaginaryPartComplex(a) 27950f81f78SJed Brown #define PetscAbsScalar(a) PetscAbsComplex(a) 28050f81f78SJed Brown #define PetscConj(a) PetscConjComplex(a) 28150f81f78SJed Brown #define PetscSqrtScalar(a) PetscSqrtComplex(a) 28250f81f78SJed Brown #define PetscPowScalar(a,b) PetscPowComplex(a,b) 28350f81f78SJed Brown #define PetscExpScalar(a) PetscExpComplex(a) 28450f81f78SJed Brown #define PetscLogScalar(a) PetscLogComplex(a) 28550f81f78SJed Brown #define PetscSinScalar(a) PetscSinComplex(a) 28650f81f78SJed Brown #define PetscCosScalar(a) PetscCosComplex(a) 287255453a1SBarry Smith #define PetscAsinScalar(a) PetscAsinComplex(a) 288255453a1SBarry Smith #define PetscAcosScalar(a) PetscAcosComplex(a) 289a4bea5a6SPeter Brune #define PetscTanScalar(a) PetscTanComplex(a) 290a4bea5a6SPeter Brune #define PetscSinhScalar(a) PetscSinhComplex(a) 291a4bea5a6SPeter Brune #define PetscCoshScalar(a) PetscCoshComplex(a) 292a4bea5a6SPeter Brune #define PetscTanhScalar(a) PetscTanhComplex(a) 2937c2de775SJed Brown #define MPIU_SCALAR MPIU_COMPLEX 29475567043SBarry Smith 2951093a601SBarry Smith /* 2961093a601SBarry Smith real number definitions 2971093a601SBarry Smith */ 2981b65fc54SMatthew G Knepley #else /* PETSC_USE_COMPLEX */ 2997c2de775SJed Brown typedef PetscReal PetscScalar; 3007c2de775SJed Brown #define MPIU_SCALAR MPIU_REAL 3017c2de775SJed Brown 302329f5518SBarry Smith #define PetscRealPart(a) (a) 303c1d390e3SJed Brown #define PetscImaginaryPart(a) ((PetscReal)0.) 304c1d390e3SJed Brown PETSC_STATIC_INLINE PetscReal PetscAbsScalar(PetscScalar a) {return a < 0.0 ? -a : a;} 305e489efc1SBarry Smith #define PetscConj(a) (a) 306ce63c4c1SBarry Smith #if !defined(PETSC_USE_REAL___FLOAT128) 30718a7d68fSSatish Balay #define PetscSqrtScalar(a) sqrt(a) 308184914b5SBarry Smith #define PetscPowScalar(a,b) pow(a,b) 309184914b5SBarry Smith #define PetscExpScalar(a) exp(a) 31006c1185fSBarry Smith #define PetscLogScalar(a) log(a) 311184914b5SBarry Smith #define PetscSinScalar(a) sin(a) 312184914b5SBarry Smith #define PetscCosScalar(a) cos(a) 313255453a1SBarry Smith #define PetscAsinScalar(a) asin(a) 314255453a1SBarry Smith #define PetscAcosScalar(a) acos(a) 315a4bea5a6SPeter Brune #define PetscTanScalar(a) tan(a) 316a4bea5a6SPeter Brune #define PetscSinhScalar(a) sinh(a) 317a4bea5a6SPeter Brune #define PetscCoshScalar(a) cosh(a) 318a4bea5a6SPeter Brune #define PetscTanhScalar(a) tanh(a) 319ce63c4c1SBarry Smith #else /* PETSC_USE_REAL___FLOAT128 */ 3200d0cc1b5SBarry Smith #define PetscSqrtScalar(a) sqrtq(a) 3210d0cc1b5SBarry Smith #define PetscPowScalar(a,b) powq(a,b) 3220d0cc1b5SBarry Smith #define PetscExpScalar(a) expq(a) 3230d0cc1b5SBarry Smith #define PetscLogScalar(a) logq(a) 3240d0cc1b5SBarry Smith #define PetscSinScalar(a) sinq(a) 3250d0cc1b5SBarry Smith #define PetscCosScalar(a) cosq(a) 326255453a1SBarry Smith #define PetscAsinScalar(a) asinq(a) 327255453a1SBarry Smith #define PetscAcosScalar(a) acosq(a) 328a4bea5a6SPeter Brune #define PetscTanScalar(a) tanq(a) 329a4bea5a6SPeter Brune #define PetscSinhScalar(a) sinhq(a) 330a4bea5a6SPeter Brune #define PetscCoshScalar(a) coshq(a) 331a4bea5a6SPeter Brune #define PetscTanhScalar(a) tanhq(a) 332ce63c4c1SBarry Smith #endif /* PETSC_USE_REAL___FLOAT128 */ 333b0a32e0cSBarry Smith 3341b65fc54SMatthew G Knepley #endif /* PETSC_USE_COMPLEX */ 335e489efc1SBarry Smith 336da9b6338SBarry Smith #define PetscSign(a) (((a) >= 0) ? ((a) == 0 ? 0 : 1) : -1) 33726aa1773SMatthew Knepley #define PetscAbs(a) (((a) >= 0) ? (a) : -(a)) 3383f1db9ecSBarry Smith 339314da920SBarry Smith /* --------------------------------------------------------------------------*/ 340314da920SBarry Smith 341e489efc1SBarry Smith /* 342f22f69f0SBarry Smith Certain objects may be created using either single or double precision. 343f22f69f0SBarry Smith This is currently not used. 344e489efc1SBarry Smith */ 345557d4da8SBarry Smith typedef enum { PETSC_SCALAR_DOUBLE,PETSC_SCALAR_SINGLE, PETSC_SCALAR_LONG_DOUBLE } PetscScalarPrecision; 346e489efc1SBarry Smith 34750f81f78SJed Brown #if defined(PETSC_HAVE_COMPLEX) 348e489efc1SBarry Smith /* PETSC_i is the imaginary number, i */ 34950f81f78SJed Brown PETSC_EXTERN PetscComplex PETSC_i; 35050f81f78SJed Brown #endif 351e489efc1SBarry Smith 352b6a5bde7SBarry Smith /*MC 353b6a5bde7SBarry Smith PetscMin - Returns minimum of two numbers 354b6a5bde7SBarry Smith 355eca87e8dSBarry Smith Synopsis: 356aaa7dc30SBarry Smith #include <petscmath.h> 357eca87e8dSBarry Smith type PetscMin(type v1,type v2) 358eca87e8dSBarry Smith 359eca87e8dSBarry Smith Not Collective 360eca87e8dSBarry Smith 361b6a5bde7SBarry Smith Input Parameter: 362b6a5bde7SBarry Smith + v1 - first value to find minimum of 363b6a5bde7SBarry Smith - v2 - second value to find minimum of 364b6a5bde7SBarry Smith 365b6a5bde7SBarry Smith Notes: type can be integer or floating point value 366b6a5bde7SBarry Smith 367b6a5bde7SBarry Smith Level: beginner 368b6a5bde7SBarry Smith 369d9a4bb16SJed Brown .seealso: PetscMin(), PetscClipInterval(), PetscAbsInt(), PetscAbsReal(), PetscSqr() 370b6a5bde7SBarry Smith 371b6a5bde7SBarry Smith M*/ 372e489efc1SBarry Smith #define PetscMin(a,b) (((a)<(b)) ? (a) : (b)) 373b6a5bde7SBarry Smith 374b6a5bde7SBarry Smith /*MC 375b6a5bde7SBarry Smith PetscMax - Returns maxium of two numbers 376b6a5bde7SBarry Smith 377eca87e8dSBarry Smith Synopsis: 378aaa7dc30SBarry Smith #include <petscmath.h> 379eca87e8dSBarry Smith type max PetscMax(type v1,type v2) 380eca87e8dSBarry Smith 381eca87e8dSBarry Smith Not Collective 382eca87e8dSBarry Smith 383b6a5bde7SBarry Smith Input Parameter: 384b6a5bde7SBarry Smith + v1 - first value to find maximum of 385b6a5bde7SBarry Smith - v2 - second value to find maximum of 386b6a5bde7SBarry Smith 387b6a5bde7SBarry Smith Notes: type can be integer or floating point value 388b6a5bde7SBarry Smith 389b6a5bde7SBarry Smith Level: beginner 390b6a5bde7SBarry Smith 391d9a4bb16SJed Brown .seealso: PetscMin(), PetscClipInterval(), PetscAbsInt(), PetscAbsReal(), PetscSqr() 392b6a5bde7SBarry Smith 393b6a5bde7SBarry Smith M*/ 394e489efc1SBarry Smith #define PetscMax(a,b) (((a)<(b)) ? (b) : (a)) 395b6a5bde7SBarry Smith 396b6a5bde7SBarry Smith /*MC 397d9a4bb16SJed Brown PetscClipInterval - Returns a number clipped to be within an interval 398d9a4bb16SJed Brown 399d9a4bb16SJed Brown Synopsis: 400aaa7dc30SBarry Smith #include <petscmath.h> 401d9a4bb16SJed Brown type clip PetscClipInterval(type x,type a,type b) 402d9a4bb16SJed Brown 403d9a4bb16SJed Brown Not Collective 404d9a4bb16SJed Brown 405d9a4bb16SJed Brown Input Parameter: 406d9a4bb16SJed Brown + x - value to use if within interval (a,b) 407d9a4bb16SJed Brown . a - lower end of interval 408d9a4bb16SJed Brown - b - upper end of interval 409d9a4bb16SJed Brown 410d9a4bb16SJed Brown Notes: type can be integer or floating point value 411d9a4bb16SJed Brown 412d9a4bb16SJed Brown Level: beginner 413d9a4bb16SJed Brown 414d9a4bb16SJed Brown .seealso: PetscMin(), PetscMax(), PetscAbsInt(), PetscAbsReal(), PetscSqr() 415d9a4bb16SJed Brown 416d9a4bb16SJed Brown M*/ 417d9a4bb16SJed Brown #define PetscClipInterval(x,a,b) (PetscMax((a),PetscMin((x),(b)))) 418d9a4bb16SJed Brown 419d9a4bb16SJed Brown /*MC 420b6a5bde7SBarry Smith PetscAbsInt - Returns the absolute value of an integer 421b6a5bde7SBarry Smith 422b6a5bde7SBarry Smith Synopsis: 423aaa7dc30SBarry Smith #include <petscmath.h> 424b6a5bde7SBarry Smith int abs PetscAbsInt(int v1) 425b6a5bde7SBarry Smith 426eca87e8dSBarry Smith Not Collective 427eca87e8dSBarry Smith 428eca87e8dSBarry Smith Input Parameter: 429eca87e8dSBarry Smith . v1 - the integer 430b6a5bde7SBarry Smith 431b6a5bde7SBarry Smith Level: beginner 432b6a5bde7SBarry Smith 433b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsReal(), PetscSqr() 434b6a5bde7SBarry Smith 435b6a5bde7SBarry Smith M*/ 436e489efc1SBarry Smith #define PetscAbsInt(a) (((a)<0) ? -(a) : (a)) 437b6a5bde7SBarry Smith 438b6a5bde7SBarry Smith /*MC 439b6a5bde7SBarry Smith PetscAbsReal - Returns the absolute value of an real number 440b6a5bde7SBarry Smith 441eca87e8dSBarry Smith Synopsis: 442aaa7dc30SBarry Smith #include <petscmath.h> 443eca87e8dSBarry Smith Real abs PetscAbsReal(PetscReal v1) 444eca87e8dSBarry Smith 445eca87e8dSBarry Smith Not Collective 446eca87e8dSBarry Smith 447b6a5bde7SBarry Smith Input Parameter: 448b6a5bde7SBarry Smith . v1 - the double 449b6a5bde7SBarry Smith 450b6a5bde7SBarry Smith 451b6a5bde7SBarry Smith Level: beginner 452b6a5bde7SBarry Smith 453b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsInt(), PetscSqr() 454b6a5bde7SBarry Smith 455b6a5bde7SBarry Smith M*/ 456f6275e2eSBarry Smith #define PetscAbsReal(a) (((a)<0) ? -(a) : (a)) 457b6a5bde7SBarry Smith 458b6a5bde7SBarry Smith /*MC 459b6a5bde7SBarry Smith PetscSqr - Returns the square of a number 460b6a5bde7SBarry Smith 461b6a5bde7SBarry Smith Synopsis: 462aaa7dc30SBarry Smith #include <petscmath.h> 463b6a5bde7SBarry Smith type sqr PetscSqr(type v1) 464b6a5bde7SBarry Smith 465eca87e8dSBarry Smith Not Collective 466eca87e8dSBarry Smith 467eca87e8dSBarry Smith Input Parameter: 468eca87e8dSBarry Smith . v1 - the value 469eca87e8dSBarry Smith 470b6a5bde7SBarry Smith Notes: type can be integer or floating point value 471b6a5bde7SBarry Smith 472b6a5bde7SBarry Smith Level: beginner 473b6a5bde7SBarry Smith 474b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsInt(), PetscAbsReal() 475b6a5bde7SBarry Smith 476b6a5bde7SBarry Smith M*/ 4774ebda54eSMatthew Knepley #define PetscSqr(a) ((a)*(a)) 478e489efc1SBarry Smith 479314da920SBarry Smith /* ----------------------------------------------------------------------------*/ 480314da920SBarry Smith /* 481d34fcf5fSBarry Smith Basic constants 482314da920SBarry Smith */ 483ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 484d34fcf5fSBarry Smith #define PETSC_PI M_PIq 485d34fcf5fSBarry Smith #elif defined(M_PI) 486d34fcf5fSBarry Smith #define PETSC_PI M_PI 487d34fcf5fSBarry Smith #else 488faa6e9b0SMatthew G Knepley #define PETSC_PI 3.14159265358979323846264338327950288419716939937510582 489d34fcf5fSBarry Smith #endif 490d34fcf5fSBarry Smith 491ab824b78SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 49271fd2e92SBarry Smith #define PETSC_MAX_INT 2147483647 493ab824b78SBarry Smith #define PETSC_MIN_INT (-PETSC_MAX_INT - 1) 494ab824b78SBarry Smith #else 495ab824b78SBarry Smith #define PETSC_MAX_INT 9223372036854775807L 496ab824b78SBarry Smith #define PETSC_MIN_INT (-PETSC_MAX_INT - 1) 497ab824b78SBarry Smith #endif 498e489efc1SBarry Smith 499ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 500ab824b78SBarry Smith # define PETSC_MAX_REAL 3.40282346638528860e+38F 501ea345e14SBarry Smith # define PETSC_MIN_REAL -PETSC_MAX_REAL 50282a7e548SBarry Smith # define PETSC_MACHINE_EPSILON 1.19209290e-07F 50382a7e548SBarry Smith # define PETSC_SQRT_MACHINE_EPSILON 3.45266983e-04F 504cf6e855fSSatish Balay # define PETSC_SMALL 1.e-5 505ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_DOUBLE) 506ab824b78SBarry Smith # define PETSC_MAX_REAL 1.7976931348623157e+308 507ea345e14SBarry Smith # define PETSC_MIN_REAL -PETSC_MAX_REAL 50882a7e548SBarry Smith # define PETSC_MACHINE_EPSILON 2.2204460492503131e-16 50982a7e548SBarry Smith # define PETSC_SQRT_MACHINE_EPSILON 1.490116119384766e-08 510cf6e855fSSatish Balay # define PETSC_SMALL 1.e-10 511ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128) 512ea345e14SBarry Smith # define PETSC_MAX_REAL FLT128_MAX 513ce63c4c1SBarry Smith # define PETSC_MIN_REAL -FLT128_MAX 514d34fcf5fSBarry Smith # define PETSC_MACHINE_EPSILON FLT128_EPSILON 51546d881e9SBarry Smith # define PETSC_SQRT_MACHINE_EPSILON 1.38777878078e-17q 51646d881e9SBarry Smith # define PETSC_SMALL 1.e-20q 5179cf09972SJed Brown #endif 5183e523bebSBarry Smith 519e270355aSBarry Smith #define PETSC_INFINITY PETSC_MAX_REAL/4.0 520e270355aSBarry Smith #define PETSC_NINFINITY -PETSC_INFINITY 521e270355aSBarry Smith 522014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIsInfOrNanReal(PetscReal); 523bae46576SBarry Smith PETSC_EXTERN PetscErrorCode PetscIsNanReal(PetscReal); 5248b49ba18SBarry Smith PETSC_EXTERN PetscBool PetscIsNormalReal(PetscReal); 525834b1445SSatish Balay PETSC_STATIC_INLINE PetscErrorCode PetscIsInfOrNanScalar(PetscScalar v) {return PetscIsInfOrNanReal(PetscAbsScalar(v));} 526bae46576SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIsNanScalar(PetscScalar v) {return PetscIsNanReal(PetscAbsScalar(v));} 527834b1445SSatish Balay PETSC_STATIC_INLINE PetscErrorCode PetscIsNormalScalar(PetscScalar v) {return PetscIsNormalReal(PetscAbsScalar(v));} 5289a25a3ccSBarry Smith 52998725619SBarry Smith /* 53098725619SBarry Smith These macros are currently hardwired to match the regular data types, so there is no support for a different 53198725619SBarry Smith MatScalar from PetscScalar. We left the MatScalar in the source just in case we use it again. 53298725619SBarry Smith */ 53398725619SBarry Smith #define MPIU_MATSCALAR MPIU_SCALAR 53498725619SBarry Smith typedef PetscScalar MatScalar; 53598725619SBarry Smith typedef PetscReal MatReal; 53698725619SBarry Smith 5378ad47952SJed Brown struct petsc_mpiu_2scalar {PetscScalar a,b;}; 5388ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_2SCALAR PetscAttrMPITypeTagLayoutCompatible(struct petsc_mpiu_2scalar); 5398ad47952SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 5408ad47952SJed Brown struct petsc_mpiu_2int {PetscInt a,b;}; 5418ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_2INT PetscAttrMPITypeTagLayoutCompatible(struct petsc_mpiu_2int); 5428ad47952SJed Brown #else 5438ad47952SJed Brown #define MPIU_2INT MPI_2INT 5448ad47952SJed Brown #endif 545e9fa29b7SSatish Balay 546b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscInt PetscPowInt(PetscInt base,PetscInt power) 547b2fb0278SBarry Smith { 548fa711258SJed Brown PetscInt result = 1; 549fa711258SJed Brown while (power) { 550fa711258SJed Brown if (power & 1) result *= base; 551fa711258SJed Brown power >>= 1; 552fa711258SJed Brown base *= base; 553fa711258SJed Brown } 554fa711258SJed Brown return result; 555fa711258SJed Brown } 556b2fb0278SBarry Smith 557b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscReal PetscPowRealInt(PetscReal base,PetscInt power) 558b2fb0278SBarry Smith { 559fa711258SJed Brown PetscReal result = 1; 560d98d5da7SBarry Smith if (power < 0) { 561d98d5da7SBarry Smith power = -power; 56210d40e53SLisandro Dalcin base = ((PetscReal)1)/base; 563d98d5da7SBarry Smith } 564fa711258SJed Brown while (power) { 565fa711258SJed Brown if (power & 1) result *= base; 566fa711258SJed Brown power >>= 1; 567fa711258SJed Brown base *= base; 568fa711258SJed Brown } 569fa711258SJed Brown return result; 570fa711258SJed Brown } 571fa711258SJed Brown 572b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscScalar PetscPowScalarInt(PetscScalar base,PetscInt power) 573b2fb0278SBarry Smith { 5748b49ba18SBarry Smith PetscScalar result = 1; 5758b49ba18SBarry Smith if (power < 0) { 5768b49ba18SBarry Smith power = -power; 57710d40e53SLisandro Dalcin base = ((PetscReal)1)/base; 5788b49ba18SBarry Smith } 5798b49ba18SBarry Smith while (power) { 5808b49ba18SBarry Smith if (power & 1) result *= base; 5818b49ba18SBarry Smith power >>= 1; 5828b49ba18SBarry Smith base *= base; 5838b49ba18SBarry Smith } 5848b49ba18SBarry Smith return result; 5858b49ba18SBarry Smith } 5868b49ba18SBarry Smith 587b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscScalar PetscPowScalarReal(PetscScalar base,PetscReal power) 588b2fb0278SBarry Smith { 589b2fb0278SBarry Smith PetscScalar cpower = power; 590b2fb0278SBarry Smith return PetscPowScalar(base,cpower); 591b2fb0278SBarry Smith } 59278a59e97SMatthew G. Knepley 59378a59e97SMatthew G. Knepley #ifndef PETSC_HAVE_LOG2 59478a59e97SMatthew G. Knepley PETSC_STATIC_INLINE PetscReal PetscLog2Real(PetscReal n) 59578a59e97SMatthew G. Knepley { 59691954be4SBarry Smith return PetscLogReal(n)/PetscLogReal(2.0); 59778a59e97SMatthew G. Knepley } 59878a59e97SMatthew G. Knepley #endif 599e489efc1SBarry Smith #endif 600