xref: /petsc/include/petscmath.h (revision ec42abe4643b25a91cda10062208073576355e57)
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>
119*ec42abe4SAlejandro Lamas Daviña #elif defined(PETSC_HAVE_VECCUDA)
120*ec42abe4SAlejandro Lamas Daviña #define complexlib thrust
121*ec42abe4SAlejandro Lamas Daviña #include <thrust/complex.h>
122debe9ee2SPaul Mullowney #else
123debe9ee2SPaul Mullowney #define complexlib std
124debe9ee2SPaul Mullowney #include <complex>
1259ae82921SPaul Mullowney #endif
126b7940d39SSatish Balay 
12750f81f78SJed Brown #define PetscRealPartComplex(a)      (a).real()
12850f81f78SJed Brown #define PetscImaginaryPartComplex(a) (a).imag()
12950f81f78SJed Brown #define PetscAbsComplex(a)           complexlib::abs(a)
13050f81f78SJed Brown #define PetscConjComplex(a)          complexlib::conj(a)
13150f81f78SJed Brown #define PetscSqrtComplex(a)          complexlib::sqrt(a)
13250f81f78SJed Brown #define PetscPowComplex(a,b)         complexlib::pow(a,b)
13350f81f78SJed Brown #define PetscExpComplex(a)           complexlib::exp(a)
13450f81f78SJed Brown #define PetscLogComplex(a)           complexlib::log(a)
13550f81f78SJed Brown #define PetscSinComplex(a)           complexlib::sin(a)
13650f81f78SJed Brown #define PetscCosComplex(a)           complexlib::cos(a)
137255453a1SBarry Smith #define PetscAsinComplex(a)          complexlib::asin(a)
138255453a1SBarry Smith #define PetscAcosComplex(a)          complexlib::acos(a)
139027d9794SBarry Smith #if defined(PETSC_HAVE_TANCOMPLEX)
140a4bea5a6SPeter Brune #define PetscTanComplex(a)           complexlib::tan(a)
141027d9794SBarry Smith #else
142027d9794SBarry Smith #define PetscTanComplex(a)           PetscSinComplex(a)/PetscCosComplex(a)
143027d9794SBarry Smith #endif
144a4bea5a6SPeter Brune #define PetscSinhComplex(a)          complexlib::sinh(a)
145a4bea5a6SPeter Brune #define PetscCoshComplex(a)          complexlib::cosh(a)
146027d9794SBarry Smith #if defined(PETSC_HAVE_TANHCOMPLEX)
147a4bea5a6SPeter Brune #define PetscTanhComplex(a)          complexlib::tanh(a)
148027d9794SBarry Smith #else
149027d9794SBarry Smith #define PetscTanhComplex(a)          PetscSinhComplex(a)/PetscCoshComplex(a)
150027d9794SBarry Smith #endif
151debe9ee2SPaul Mullowney 
152debe9ee2SPaul Mullowney #if defined(PETSC_USE_REAL_SINGLE)
15350f81f78SJed Brown typedef complexlib::complex<float> PetscComplex;
1543be776deSLisandro Dalcin #if defined(PETSC_USE_CXX_COMPLEX_FLOAT_WORKAROUND)
1553be776deSLisandro Dalcin static inline PetscComplex operator+(const PetscComplex& lhs, const double& rhs) { return lhs + float(rhs); }
1563be776deSLisandro Dalcin static inline PetscComplex operator+(const double& lhs, const PetscComplex& rhs) { return float(lhs) + rhs; }
1573be776deSLisandro Dalcin static inline PetscComplex operator-(const PetscComplex& lhs, const double& rhs) { return lhs - float(rhs); }
1583be776deSLisandro Dalcin static inline PetscComplex operator-(const double& lhs, const PetscComplex& rhs) { return float(lhs) - rhs; }
1593be776deSLisandro Dalcin static inline PetscComplex operator*(const PetscComplex& lhs, const double& rhs) { return lhs * float(rhs); }
1603be776deSLisandro Dalcin static inline PetscComplex operator*(const double& lhs, const PetscComplex& rhs) { return float(lhs) * rhs; }
1613be776deSLisandro Dalcin static inline PetscComplex operator/(const PetscComplex& lhs, const double& rhs) { return lhs / float(rhs); }
1623be776deSLisandro Dalcin static inline PetscComplex operator/(const double& lhs, const PetscComplex& rhs) { return float(lhs) / rhs; }
1633be776deSLisandro Dalcin static inline bool operator==(const PetscComplex& lhs, const double& rhs) { return lhs.imag() == float(0) && lhs.real() == float(rhs); }
1643be776deSLisandro Dalcin static inline bool operator==(const double& lhs, const PetscComplex& rhs) { return rhs.imag() == float(0) && rhs.real() == float(lhs); }
1653be776deSLisandro Dalcin static inline bool operator!=(const PetscComplex& lhs, const double& rhs) { return lhs.imag() != float(0) || lhs.real() != float(rhs); }
1663be776deSLisandro Dalcin static inline bool operator!=(const double& lhs, const PetscComplex& rhs) { return rhs.imag() != float(0) || rhs.real() != float(lhs); }
1673be776deSLisandro Dalcin #endif  /* PETSC_USE_CXX_COMPLEX_FLOAT_WORKAROUND */
168debe9ee2SPaul Mullowney #elif defined(PETSC_USE_REAL_DOUBLE)
16950f81f78SJed Brown typedef complexlib::complex<double> PetscComplex;
1708c764dc5SJose Roman #elif defined(PETSC_USE_REAL___FLOAT128)
17150f81f78SJed Brown typedef complexlib::complex<__float128> PetscComplex; /* Notstandard and not expected to work, use __complex128 */
17222b3908eSBarry Smith PETSC_EXTERN MPI_Datatype MPIU___COMPLEX128;
173debe9ee2SPaul Mullowney #endif  /* PETSC_USE_REAL_ */
1748cd53115SBarry Smith #endif  /* ! PETSC_SKIP_COMPLEX */
175debe9ee2SPaul Mullowney 
1762f217381SBarry Smith #elif !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX)
1778cd53115SBarry Smith #if !defined(PETSC_SKIP_COMPLEX)
1789f20b660SSatish Balay #define PETSC_HAVE_COMPLEX 1
179519e2a1fSPaul Mullowney #include <complex.h>
180519e2a1fSPaul Mullowney 
181ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
18250f81f78SJed Brown typedef float _Complex PetscComplex;
18385b47369SMatthew Knepley 
18450f81f78SJed Brown #define PetscRealPartComplex(a)      crealf(a)
18550f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimagf(a)
18650f81f78SJed Brown #define PetscAbsComplex(a)           cabsf(a)
18750f81f78SJed Brown #define PetscConjComplex(a)          conjf(a)
18850f81f78SJed Brown #define PetscSqrtComplex(a)          csqrtf(a)
18950f81f78SJed Brown #define PetscPowComplex(a,b)         cpowf(a,b)
19050f81f78SJed Brown #define PetscExpComplex(a)           cexpf(a)
19150f81f78SJed Brown #define PetscLogComplex(a)           clogf(a)
19250f81f78SJed Brown #define PetscSinComplex(a)           csinf(a)
19350f81f78SJed Brown #define PetscCosComplex(a)           ccosf(a)
194255453a1SBarry Smith #define PetscAsinComplex(a)          casinf(a)
195255453a1SBarry Smith #define PetscAcosComplex(a)          cacosf(a)
196a4bea5a6SPeter Brune #define PetscTanComplex(a)           ctanf(a)
197a4bea5a6SPeter Brune #define PetscSinhComplex(a)          csinhf(a)
198a4bea5a6SPeter Brune #define PetscCoshComplex(a)          ccoshf(a)
199a4bea5a6SPeter Brune #define PetscTanhComplex(a)          ctanhf(a)
2001093a601SBarry Smith 
201ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_DOUBLE)
20250f81f78SJed Brown typedef double _Complex PetscComplex;
2031093a601SBarry Smith 
20450f81f78SJed Brown #define PetscRealPartComplex(a)      creal(a)
20550f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimag(a)
20650f81f78SJed Brown #define PetscAbsComplex(a)           cabs(a)
20750f81f78SJed Brown #define PetscConjComplex(a)          conj(a)
20850f81f78SJed Brown #define PetscSqrtComplex(a)          csqrt(a)
20950f81f78SJed Brown #define PetscPowComplex(a,b)         cpow(a,b)
21050f81f78SJed Brown #define PetscExpComplex(a)           cexp(a)
21150f81f78SJed Brown #define PetscLogComplex(a)           clog(a)
21250f81f78SJed Brown #define PetscSinComplex(a)           csin(a)
21350f81f78SJed Brown #define PetscCosComplex(a)           ccos(a)
214255453a1SBarry Smith #define PetscAsinComplex(a)          casin(a)
215255453a1SBarry Smith #define PetscAcosComplex(a)          cacos(a)
216a4bea5a6SPeter Brune #define PetscTanComplex(a)           ctan(a)
217a4bea5a6SPeter Brune #define PetscSinhComplex(a)          csinh(a)
218a4bea5a6SPeter Brune #define PetscCoshComplex(a)          ccosh(a)
219a4bea5a6SPeter Brune #define PetscTanhComplex(a)          ctanh(a)
2201093a601SBarry Smith 
2218c764dc5SJose Roman #elif defined(PETSC_USE_REAL___FLOAT128)
22250f81f78SJed Brown typedef __complex128 PetscComplex;
2238ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU___COMPLEX128 PetscAttrMPITypeTag(__complex128);
2248c764dc5SJose Roman 
22550f81f78SJed Brown #define PetscRealPartComplex(a)      crealq(a)
22650f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimagq(a)
22750f81f78SJed Brown #define PetscAbsComplex(a)           cabsq(a)
22850f81f78SJed Brown #define PetscConjComplex(a)          conjq(a)
22950f81f78SJed Brown #define PetscSqrtComplex(a)          csqrtq(a)
23050f81f78SJed Brown #define PetscPowComplex(a,b)         cpowq(a,b)
23150f81f78SJed Brown #define PetscExpComplex(a)           cexpq(a)
23250f81f78SJed Brown #define PetscLogComplex(a)           clogq(a)
23350f81f78SJed Brown #define PetscSinComplex(a)           csinq(a)
23450f81f78SJed Brown #define PetscCosComplex(a)           ccosq(a)
235255453a1SBarry Smith #define PetscAsinComplex(a)          casinq(a)
236255453a1SBarry Smith #define PetscAcosComplex(a)          cacosq(a)
237a4bea5a6SPeter Brune #define PetscTanComplex(a)           ctanq(a)
238a4bea5a6SPeter Brune #define PetscSinhComplex(a)          csinhq(a)
239a4bea5a6SPeter Brune #define PetscCoshComplex(a)          ccoshq(a)
240a4bea5a6SPeter Brune #define PetscTanhComplex(a)          ctanhq(a)
241a4bea5a6SPeter Brune 
242ce63c4c1SBarry Smith #endif /* PETSC_USE_REAL_* */
243d4161b4aSBarry Smith #elif (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX))
24450f81f78SJed Brown #error "PETSc was configured --with-scalar-type=complex, but a language-appropriate complex library is not available"
2458cd53115SBarry Smith #endif /* !PETSC_SKIP_COMPLEX */
2462f217381SBarry Smith #endif /* (__cplusplus && PETSC_HAVE_CXX_COMPLEX) else-if (!__cplusplus && PETSC_HAVE_C99_COMPLEX) */
247e489efc1SBarry Smith 
2488dc6f2c2SJed Brown #if defined(PETSC_HAVE_COMPLEX)
24970da9c3bSJed Brown #if defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
250500d8756SSatish Balay #define MPIU_C_DOUBLE_COMPLEX MPI_C_DOUBLE_COMPLEX
251500d8756SSatish Balay #define MPIU_C_COMPLEX MPI_C_COMPLEX
25270da9c3bSJed Brown #else
2532f217381SBarry Smith # if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX)
2548ad47952SJed Brown   typedef complexlib::complex<double> petsc_mpiu_c_double_complex;
2558ad47952SJed Brown   typedef complexlib::complex<float> petsc_mpiu_c_complex;
2562f217381SBarry Smith # elif !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX)
2578ad47952SJed Brown   typedef double _Complex petsc_mpiu_c_double_complex;
2588ad47952SJed Brown   typedef float _Complex petsc_mpiu_c_complex;
2598ad47952SJed Brown # else
2608ad47952SJed Brown   typedef struct {double real,imag;} petsc_mpiu_c_double_complex;
2618ad47952SJed Brown   typedef struct {float real,imag;} petsc_mpiu_c_complex;
2628ad47952SJed Brown # endif
2638ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_C_DOUBLE_COMPLEX PetscAttrMPITypeTagLayoutCompatible(petsc_mpiu_c_double_complex);
2648ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_C_COMPLEX PetscAttrMPITypeTagLayoutCompatible(petsc_mpiu_c_complex);
2651b65fc54SMatthew G Knepley #endif /* PETSC_HAVE_MPI_C_DOUBLE_COMPLEX */
2668dc6f2c2SJed Brown #endif /* PETSC_HAVE_COMPLEX */
2672c876bd9SBarry Smith 
2687c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2697c2de775SJed Brown #  if defined(PETSC_USE_REAL_SINGLE)
2707c2de775SJed Brown #    define MPIU_COMPLEX MPIU_C_COMPLEX
2717c2de775SJed Brown #  elif defined(PETSC_USE_REAL_DOUBLE)
2727c2de775SJed Brown #    define MPIU_COMPLEX MPIU_C_DOUBLE_COMPLEX
2737c2de775SJed Brown #  elif defined(PETSC_USE_REAL___FLOAT128)
2747c2de775SJed Brown #    define MPIU_COMPLEX MPIU___COMPLEX128
2757c2de775SJed Brown #  endif /* PETSC_USE_REAL_* */
2767c2de775SJed Brown #endif
2777c2de775SJed Brown 
278d4161b4aSBarry Smith #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX))
27950f81f78SJed Brown typedef PetscComplex PetscScalar;
28050f81f78SJed Brown #define PetscRealPart(a)      PetscRealPartComplex(a)
28150f81f78SJed Brown #define PetscImaginaryPart(a) PetscImaginaryPartComplex(a)
28250f81f78SJed Brown #define PetscAbsScalar(a)     PetscAbsComplex(a)
28350f81f78SJed Brown #define PetscConj(a)          PetscConjComplex(a)
28450f81f78SJed Brown #define PetscSqrtScalar(a)    PetscSqrtComplex(a)
28550f81f78SJed Brown #define PetscPowScalar(a,b)   PetscPowComplex(a,b)
28650f81f78SJed Brown #define PetscExpScalar(a)     PetscExpComplex(a)
28750f81f78SJed Brown #define PetscLogScalar(a)     PetscLogComplex(a)
28850f81f78SJed Brown #define PetscSinScalar(a)     PetscSinComplex(a)
28950f81f78SJed Brown #define PetscCosScalar(a)     PetscCosComplex(a)
290255453a1SBarry Smith #define PetscAsinScalar(a)    PetscAsinComplex(a)
291255453a1SBarry Smith #define PetscAcosScalar(a)    PetscAcosComplex(a)
292a4bea5a6SPeter Brune #define PetscTanScalar(a)     PetscTanComplex(a)
293a4bea5a6SPeter Brune #define PetscSinhScalar(a)    PetscSinhComplex(a)
294a4bea5a6SPeter Brune #define PetscCoshScalar(a)    PetscCoshComplex(a)
295a4bea5a6SPeter Brune #define PetscTanhScalar(a)    PetscTanhComplex(a)
2967c2de775SJed Brown #define MPIU_SCALAR MPIU_COMPLEX
29775567043SBarry Smith 
2981093a601SBarry Smith /*
2991093a601SBarry Smith     real number definitions
3001093a601SBarry Smith  */
3011b65fc54SMatthew G Knepley #else /* PETSC_USE_COMPLEX */
3027c2de775SJed Brown typedef PetscReal PetscScalar;
3037c2de775SJed Brown #define MPIU_SCALAR MPIU_REAL
3047c2de775SJed Brown 
305329f5518SBarry Smith #define PetscRealPart(a)      (a)
306c1d390e3SJed Brown #define PetscImaginaryPart(a) ((PetscReal)0.)
307c1d390e3SJed Brown PETSC_STATIC_INLINE PetscReal PetscAbsScalar(PetscScalar a) {return a < 0.0 ? -a : a;}
308e489efc1SBarry Smith #define PetscConj(a)          (a)
309ce63c4c1SBarry Smith #if !defined(PETSC_USE_REAL___FLOAT128)
31018a7d68fSSatish Balay #define PetscSqrtScalar(a)    sqrt(a)
311184914b5SBarry Smith #define PetscPowScalar(a,b)   pow(a,b)
312184914b5SBarry Smith #define PetscExpScalar(a)     exp(a)
31306c1185fSBarry Smith #define PetscLogScalar(a)     log(a)
314184914b5SBarry Smith #define PetscSinScalar(a)     sin(a)
315184914b5SBarry Smith #define PetscCosScalar(a)     cos(a)
316255453a1SBarry Smith #define PetscAsinScalar(a)    asin(a)
317255453a1SBarry Smith #define PetscAcosScalar(a)    acos(a)
318a4bea5a6SPeter Brune #define PetscTanScalar(a)     tan(a)
319a4bea5a6SPeter Brune #define PetscSinhScalar(a)    sinh(a)
320a4bea5a6SPeter Brune #define PetscCoshScalar(a)    cosh(a)
321a4bea5a6SPeter Brune #define PetscTanhScalar(a)    tanh(a)
322ce63c4c1SBarry Smith #else /* PETSC_USE_REAL___FLOAT128 */
3230d0cc1b5SBarry Smith #define PetscSqrtScalar(a)    sqrtq(a)
3240d0cc1b5SBarry Smith #define PetscPowScalar(a,b)   powq(a,b)
3250d0cc1b5SBarry Smith #define PetscExpScalar(a)     expq(a)
3260d0cc1b5SBarry Smith #define PetscLogScalar(a)     logq(a)
3270d0cc1b5SBarry Smith #define PetscSinScalar(a)     sinq(a)
3280d0cc1b5SBarry Smith #define PetscCosScalar(a)     cosq(a)
329255453a1SBarry Smith #define PetscAsinScalar(a)    asinq(a)
330255453a1SBarry Smith #define PetscAcosScalar(a)    acosq(a)
331a4bea5a6SPeter Brune #define PetscTanScalar(a)     tanq(a)
332a4bea5a6SPeter Brune #define PetscSinhScalar(a)    sinhq(a)
333a4bea5a6SPeter Brune #define PetscCoshScalar(a)    coshq(a)
334a4bea5a6SPeter Brune #define PetscTanhScalar(a)    tanhq(a)
335ce63c4c1SBarry Smith #endif /* PETSC_USE_REAL___FLOAT128 */
336b0a32e0cSBarry Smith 
3371b65fc54SMatthew G Knepley #endif /* PETSC_USE_COMPLEX */
338e489efc1SBarry Smith 
339da9b6338SBarry Smith #define PetscSign(a) (((a) >= 0) ? ((a) == 0 ? 0 : 1) : -1)
34026aa1773SMatthew Knepley #define PetscAbs(a)  (((a) >= 0) ? (a) : -(a))
3413f1db9ecSBarry Smith 
342314da920SBarry Smith /* --------------------------------------------------------------------------*/
343314da920SBarry Smith 
344e489efc1SBarry Smith /*
345f22f69f0SBarry Smith    Certain objects may be created using either single or double precision.
346f22f69f0SBarry Smith    This is currently not used.
347e489efc1SBarry Smith */
348557d4da8SBarry Smith typedef enum { PETSC_SCALAR_DOUBLE,PETSC_SCALAR_SINGLE, PETSC_SCALAR_LONG_DOUBLE } PetscScalarPrecision;
349e489efc1SBarry Smith 
35050f81f78SJed Brown #if defined(PETSC_HAVE_COMPLEX)
351e489efc1SBarry Smith /* PETSC_i is the imaginary number, i */
35250f81f78SJed Brown PETSC_EXTERN PetscComplex PETSC_i;
35350f81f78SJed Brown #endif
354e489efc1SBarry Smith 
355b6a5bde7SBarry Smith /*MC
356b6a5bde7SBarry Smith    PetscMin - Returns minimum of two numbers
357b6a5bde7SBarry Smith 
358eca87e8dSBarry Smith    Synopsis:
359aaa7dc30SBarry Smith    #include <petscmath.h>
360eca87e8dSBarry Smith    type PetscMin(type v1,type v2)
361eca87e8dSBarry Smith 
362eca87e8dSBarry Smith    Not Collective
363eca87e8dSBarry Smith 
364b6a5bde7SBarry Smith    Input Parameter:
365b6a5bde7SBarry Smith +  v1 - first value to find minimum of
366b6a5bde7SBarry Smith -  v2 - second value to find minimum of
367b6a5bde7SBarry Smith 
368b6a5bde7SBarry Smith    Notes: type can be integer or floating point value
369b6a5bde7SBarry Smith 
370b6a5bde7SBarry Smith    Level: beginner
371b6a5bde7SBarry Smith 
372d9a4bb16SJed Brown .seealso: PetscMin(), PetscClipInterval(), PetscAbsInt(), PetscAbsReal(), PetscSqr()
373b6a5bde7SBarry Smith 
374b6a5bde7SBarry Smith M*/
375e489efc1SBarry Smith #define PetscMin(a,b)   (((a)<(b)) ?  (a) : (b))
376b6a5bde7SBarry Smith 
377b6a5bde7SBarry Smith /*MC
378b6a5bde7SBarry Smith    PetscMax - Returns maxium of two numbers
379b6a5bde7SBarry Smith 
380eca87e8dSBarry Smith    Synopsis:
381aaa7dc30SBarry Smith    #include <petscmath.h>
382eca87e8dSBarry Smith    type max PetscMax(type v1,type v2)
383eca87e8dSBarry Smith 
384eca87e8dSBarry Smith    Not Collective
385eca87e8dSBarry Smith 
386b6a5bde7SBarry Smith    Input Parameter:
387b6a5bde7SBarry Smith +  v1 - first value to find maximum of
388b6a5bde7SBarry Smith -  v2 - second value to find maximum of
389b6a5bde7SBarry Smith 
390b6a5bde7SBarry Smith    Notes: type can be integer or floating point value
391b6a5bde7SBarry Smith 
392b6a5bde7SBarry Smith    Level: beginner
393b6a5bde7SBarry Smith 
394d9a4bb16SJed Brown .seealso: PetscMin(), PetscClipInterval(), PetscAbsInt(), PetscAbsReal(), PetscSqr()
395b6a5bde7SBarry Smith 
396b6a5bde7SBarry Smith M*/
397e489efc1SBarry Smith #define PetscMax(a,b)   (((a)<(b)) ?  (b) : (a))
398b6a5bde7SBarry Smith 
399b6a5bde7SBarry Smith /*MC
400d9a4bb16SJed Brown    PetscClipInterval - Returns a number clipped to be within an interval
401d9a4bb16SJed Brown 
402d9a4bb16SJed Brown    Synopsis:
403aaa7dc30SBarry Smith    #include <petscmath.h>
404d9a4bb16SJed Brown    type clip PetscClipInterval(type x,type a,type b)
405d9a4bb16SJed Brown 
406d9a4bb16SJed Brown    Not Collective
407d9a4bb16SJed Brown 
408d9a4bb16SJed Brown    Input Parameter:
409d9a4bb16SJed Brown +  x - value to use if within interval (a,b)
410d9a4bb16SJed Brown .  a - lower end of interval
411d9a4bb16SJed Brown -  b - upper end of interval
412d9a4bb16SJed Brown 
413d9a4bb16SJed Brown    Notes: type can be integer or floating point value
414d9a4bb16SJed Brown 
415d9a4bb16SJed Brown    Level: beginner
416d9a4bb16SJed Brown 
417d9a4bb16SJed Brown .seealso: PetscMin(), PetscMax(), PetscAbsInt(), PetscAbsReal(), PetscSqr()
418d9a4bb16SJed Brown 
419d9a4bb16SJed Brown M*/
420d9a4bb16SJed Brown #define PetscClipInterval(x,a,b)   (PetscMax((a),PetscMin((x),(b))))
421d9a4bb16SJed Brown 
422d9a4bb16SJed Brown /*MC
423b6a5bde7SBarry Smith    PetscAbsInt - Returns the absolute value of an integer
424b6a5bde7SBarry Smith 
425b6a5bde7SBarry Smith    Synopsis:
426aaa7dc30SBarry Smith    #include <petscmath.h>
427b6a5bde7SBarry Smith    int abs PetscAbsInt(int v1)
428b6a5bde7SBarry Smith 
429eca87e8dSBarry Smith    Not Collective
430eca87e8dSBarry Smith 
431eca87e8dSBarry Smith    Input Parameter:
432eca87e8dSBarry Smith .   v1 - the integer
433b6a5bde7SBarry Smith 
434b6a5bde7SBarry Smith    Level: beginner
435b6a5bde7SBarry Smith 
436b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsReal(), PetscSqr()
437b6a5bde7SBarry Smith 
438b6a5bde7SBarry Smith M*/
439e489efc1SBarry Smith #define PetscAbsInt(a)  (((a)<0)   ? -(a) : (a))
440b6a5bde7SBarry Smith 
441b6a5bde7SBarry Smith /*MC
442b6a5bde7SBarry Smith    PetscAbsReal - Returns the absolute value of an real number
443b6a5bde7SBarry Smith 
444eca87e8dSBarry Smith    Synopsis:
445aaa7dc30SBarry Smith    #include <petscmath.h>
446eca87e8dSBarry Smith    Real abs PetscAbsReal(PetscReal v1)
447eca87e8dSBarry Smith 
448eca87e8dSBarry Smith    Not Collective
449eca87e8dSBarry Smith 
450b6a5bde7SBarry Smith    Input Parameter:
451b6a5bde7SBarry Smith .   v1 - the double
452b6a5bde7SBarry Smith 
453b6a5bde7SBarry Smith 
454b6a5bde7SBarry Smith    Level: beginner
455b6a5bde7SBarry Smith 
456b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsInt(), PetscSqr()
457b6a5bde7SBarry Smith 
458b6a5bde7SBarry Smith M*/
459f6275e2eSBarry Smith #define PetscAbsReal(a) (((a)<0)   ? -(a) : (a))
460b6a5bde7SBarry Smith 
461b6a5bde7SBarry Smith /*MC
462b6a5bde7SBarry Smith    PetscSqr - Returns the square of a number
463b6a5bde7SBarry Smith 
464b6a5bde7SBarry Smith    Synopsis:
465aaa7dc30SBarry Smith    #include <petscmath.h>
466b6a5bde7SBarry Smith    type sqr PetscSqr(type v1)
467b6a5bde7SBarry Smith 
468eca87e8dSBarry Smith    Not Collective
469eca87e8dSBarry Smith 
470eca87e8dSBarry Smith    Input Parameter:
471eca87e8dSBarry Smith .   v1 - the value
472eca87e8dSBarry Smith 
473b6a5bde7SBarry Smith    Notes: type can be integer or floating point value
474b6a5bde7SBarry Smith 
475b6a5bde7SBarry Smith    Level: beginner
476b6a5bde7SBarry Smith 
477b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsInt(), PetscAbsReal()
478b6a5bde7SBarry Smith 
479b6a5bde7SBarry Smith M*/
4804ebda54eSMatthew Knepley #define PetscSqr(a)     ((a)*(a))
481e489efc1SBarry Smith 
482314da920SBarry Smith /* ----------------------------------------------------------------------------*/
483314da920SBarry Smith /*
484d34fcf5fSBarry Smith      Basic constants
485314da920SBarry Smith */
486ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
487d34fcf5fSBarry Smith #define PETSC_PI                 M_PIq
488d34fcf5fSBarry Smith #elif defined(M_PI)
489d34fcf5fSBarry Smith #define PETSC_PI                 M_PI
490d34fcf5fSBarry Smith #else
491faa6e9b0SMatthew G Knepley #define PETSC_PI                 3.14159265358979323846264338327950288419716939937510582
492d34fcf5fSBarry Smith #endif
493d34fcf5fSBarry Smith 
494ab824b78SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
49571fd2e92SBarry Smith #define PETSC_MAX_INT            2147483647
496ab824b78SBarry Smith #define PETSC_MIN_INT            (-PETSC_MAX_INT - 1)
497ab824b78SBarry Smith #else
498ab824b78SBarry Smith #define PETSC_MAX_INT            9223372036854775807L
499ab824b78SBarry Smith #define PETSC_MIN_INT            (-PETSC_MAX_INT - 1)
500ab824b78SBarry Smith #endif
501e489efc1SBarry Smith 
502ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
503ab824b78SBarry Smith #  define PETSC_MAX_REAL                3.40282346638528860e+38F
504ea345e14SBarry Smith #  define PETSC_MIN_REAL                -PETSC_MAX_REAL
50582a7e548SBarry Smith #  define PETSC_MACHINE_EPSILON         1.19209290e-07F
50682a7e548SBarry Smith #  define PETSC_SQRT_MACHINE_EPSILON    3.45266983e-04F
507cf6e855fSSatish Balay #  define PETSC_SMALL                   1.e-5
508ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_DOUBLE)
509ab824b78SBarry Smith #  define PETSC_MAX_REAL                1.7976931348623157e+308
510ea345e14SBarry Smith #  define PETSC_MIN_REAL                -PETSC_MAX_REAL
51182a7e548SBarry Smith #  define PETSC_MACHINE_EPSILON         2.2204460492503131e-16
51282a7e548SBarry Smith #  define PETSC_SQRT_MACHINE_EPSILON    1.490116119384766e-08
513cf6e855fSSatish Balay #  define PETSC_SMALL                   1.e-10
514ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128)
515ea345e14SBarry Smith #  define PETSC_MAX_REAL                FLT128_MAX
516ce63c4c1SBarry Smith #  define PETSC_MIN_REAL                -FLT128_MAX
517d34fcf5fSBarry Smith #  define PETSC_MACHINE_EPSILON         FLT128_EPSILON
51846d881e9SBarry Smith #  define PETSC_SQRT_MACHINE_EPSILON    1.38777878078e-17q
51946d881e9SBarry Smith #  define PETSC_SMALL                   1.e-20q
5209cf09972SJed Brown #endif
5213e523bebSBarry Smith 
522e270355aSBarry Smith #define PETSC_INFINITY                PETSC_MAX_REAL/4.0
523e270355aSBarry Smith #define PETSC_NINFINITY              -PETSC_INFINITY
524e270355aSBarry Smith 
525014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIsInfOrNanReal(PetscReal);
526bae46576SBarry Smith PETSC_EXTERN PetscErrorCode PetscIsNanReal(PetscReal);
5278b49ba18SBarry Smith PETSC_EXTERN PetscBool PetscIsNormalReal(PetscReal);
528834b1445SSatish Balay PETSC_STATIC_INLINE PetscErrorCode PetscIsInfOrNanScalar(PetscScalar v) {return PetscIsInfOrNanReal(PetscAbsScalar(v));}
529bae46576SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIsNanScalar(PetscScalar v) {return PetscIsNanReal(PetscAbsScalar(v));}
530834b1445SSatish Balay PETSC_STATIC_INLINE PetscErrorCode PetscIsNormalScalar(PetscScalar v) {return PetscIsNormalReal(PetscAbsScalar(v));}
5319a25a3ccSBarry Smith 
53298725619SBarry Smith /*
53398725619SBarry Smith     These macros are currently hardwired to match the regular data types, so there is no support for a different
53498725619SBarry Smith     MatScalar from PetscScalar. We left the MatScalar in the source just in case we use it again.
53598725619SBarry Smith  */
53698725619SBarry Smith #define MPIU_MATSCALAR MPIU_SCALAR
53798725619SBarry Smith typedef PetscScalar MatScalar;
53898725619SBarry Smith typedef PetscReal MatReal;
53998725619SBarry Smith 
5408ad47952SJed Brown struct petsc_mpiu_2scalar {PetscScalar a,b;};
5418ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_2SCALAR PetscAttrMPITypeTagLayoutCompatible(struct petsc_mpiu_2scalar);
5428ad47952SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
5438ad47952SJed Brown struct petsc_mpiu_2int {PetscInt a,b;};
5448ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_2INT PetscAttrMPITypeTagLayoutCompatible(struct petsc_mpiu_2int);
5458ad47952SJed Brown #else
5468ad47952SJed Brown #define MPIU_2INT MPI_2INT
5478ad47952SJed Brown #endif
548e9fa29b7SSatish Balay 
549b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscInt PetscPowInt(PetscInt base,PetscInt power)
550b2fb0278SBarry Smith {
551fa711258SJed Brown   PetscInt result = 1;
552fa711258SJed Brown   while (power) {
553fa711258SJed Brown     if (power & 1) result *= base;
554fa711258SJed Brown     power >>= 1;
555fa711258SJed Brown     base *= base;
556fa711258SJed Brown   }
557fa711258SJed Brown   return result;
558fa711258SJed Brown }
559b2fb0278SBarry Smith 
560b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscReal PetscPowRealInt(PetscReal base,PetscInt power)
561b2fb0278SBarry Smith {
562fa711258SJed Brown   PetscReal result = 1;
563d98d5da7SBarry Smith   if (power < 0) {
564d98d5da7SBarry Smith     power = -power;
56510d40e53SLisandro Dalcin     base  = ((PetscReal)1)/base;
566d98d5da7SBarry Smith   }
567fa711258SJed Brown   while (power) {
568fa711258SJed Brown     if (power & 1) result *= base;
569fa711258SJed Brown     power >>= 1;
570fa711258SJed Brown     base *= base;
571fa711258SJed Brown   }
572fa711258SJed Brown   return result;
573fa711258SJed Brown }
574fa711258SJed Brown 
575b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscScalar PetscPowScalarInt(PetscScalar base,PetscInt power)
576b2fb0278SBarry Smith {
5778b49ba18SBarry Smith   PetscScalar result = 1;
5788b49ba18SBarry Smith   if (power < 0) {
5798b49ba18SBarry Smith     power = -power;
58010d40e53SLisandro Dalcin     base  = ((PetscReal)1)/base;
5818b49ba18SBarry Smith   }
5828b49ba18SBarry Smith   while (power) {
5838b49ba18SBarry Smith     if (power & 1) result *= base;
5848b49ba18SBarry Smith     power >>= 1;
5858b49ba18SBarry Smith     base *= base;
5868b49ba18SBarry Smith   }
5878b49ba18SBarry Smith   return result;
5888b49ba18SBarry Smith }
5898b49ba18SBarry Smith 
590b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscScalar PetscPowScalarReal(PetscScalar base,PetscReal power)
591b2fb0278SBarry Smith {
592b2fb0278SBarry Smith   PetscScalar cpower = power;
593b2fb0278SBarry Smith   return PetscPowScalar(base,cpower);
594b2fb0278SBarry Smith }
59578a59e97SMatthew G. Knepley 
59678a59e97SMatthew G. Knepley #ifndef PETSC_HAVE_LOG2
59778a59e97SMatthew G. Knepley PETSC_STATIC_INLINE PetscReal PetscLog2Real(PetscReal n)
59878a59e97SMatthew G. Knepley {
59991954be4SBarry Smith   return PetscLogReal(n)/PetscLogReal(2.0);
60078a59e97SMatthew G. Knepley }
60178a59e97SMatthew G. Knepley #endif
602e489efc1SBarry Smith #endif
603